Commit Graph

256 Commits

Author SHA1 Message Date
Ben McGinnes 5ec720a132 Grammar fixed as indicated in issue #429. 2014-05-18 07:22:37 +10:00
Brian Dréau aa76da294d Fixed minor typos in writing/style 2014-05-17 15:36:50 +02:00
Ian Cordasco aa9c4cf577 Merge pull request #428 from schodge/patch-2
fix nested markup, literal doesn't work
2014-05-09 22:17:39 -05:00
Shayne Hodge f82061f7fc fix nested markup, literal doesn't work
Inline markup can't be nested, see http://docutils.sourceforge.net/docs/user/rst/quickref.html#inline-markup, last sentence.
2014-05-09 15:41:52 -07:00
Shayne Hodge f6735bcad7 Add backticks to inline code
Single backticks were used in places, which doesn't seem to render as code (at least on Firefox).  Line 137 has a code statement within ** ** that isn't rendering correctly, but I'm not sure how to fix it.
2014-05-08 12:09:09 -07:00
kuyan 2cff35ef30 Revise Unittest section description 2014-04-14 17:32:11 -07:00
kuyan 1800feb118 Wrap lines at 78 char as much as possible. 2014-04-14 17:08:22 -07:00
kuyan 00ebb59a19 Use :mod: tag for modules 2014-04-14 17:01:29 -07:00
kuyan ef998acd2b Revised semantics in section 'mock' 2014-04-14 13:42:03 -07:00
Zearin cc7b19356e Mark up files & directories 2014-04-11 11:26:37 -04:00
Zearin fe8e11c8e9 writing/tests.rst: Unbold “`mock`” 2014-03-31 10:48:12 -04:00
Zearin 1e4b4a5460 docs/**: Specify language for code-blocks (syntax highlighting! mmm…) 2014-03-28 13:26:24 -04:00
rogererens 8fd4e4586e Reset list 'a'
The result of the previous block containing the map example left 'a' to be [6, 7, 8], so resetting 'a'  back to [3, 4, 5] seems to keep the example in line with the other ones.
2014-03-19 23:02:37 +01:00
Ian Cordasco eec36320eb Add link to stdlib mock 2014-03-15 18:12:50 -05:00
Ian Cordasco f579b1d922 Add note about mock in Python 3.3
Closes #170
2014-03-15 16:22:20 -05:00
Nelson Chen 0506020a7f Update tests.rst
s/has names/have names/
2014-03-13 15:50:29 -07:00
Ian Cordasco f52704926c Keep it neutral 2014-03-03 06:49:26 -06:00
Leonardo.Z 6edbe90266 Add a new documentation tool: MkDocs
MkDocs is a new and popular documentation tool written in Python. It's supported by ReadTheDoc.org.
2014-03-03 14:17:51 +08:00
Jeff Hammerbacher ca240c2479 "faster on tracks" => "back on track faster" 2014-02-22 18:59:01 -05:00
Jonas Gröger c8bda6892f Added oxford comma. 2014-02-17 21:03:36 +01:00
Jonas Gröger 87ec12d320 Included tldrlegal.com
tl;drLegal is a great place to look up what a particular license is all about. The website can be found here: https://tldrlegal.com/
2014-02-17 20:52:21 +01:00
imranghory 21d8f91ac6 Make explicit whats being referred to 2014-01-25 14:37:18 +00:00
kennethreitz 8e00707d82 Merge pull request #340 from ugurthemaster/master
Update learning.rst
2014-01-08 11:26:27 -08:00
kennethreitz 5deddcafa5 Merge pull request #345 from kuyan/patch-1
Fix broken link
2014-01-08 11:24:54 -08:00
Natan L 6dfc9ae953 Fix broken link 2013-12-02 22:58:17 -08:00
ugurthemaster 203b92ce61 Update documentation.rst 2013-11-25 11:05:54 +02:00
Pengkui Luo 83630edf35 typos 2013-11-02 06:19:56 -05:00
Alois Mahdal f32ef5f38f Reworded per rgbkrk's suggestion 2013-09-24 22:28:12 +02:00
Alois Mahdal 239909dc4c Clarify presence of a two-element tuple. 2013-09-24 14:02:54 +02:00
Kenneth Reitz 202997958b Merge pull request #303 from claudejrogers/patch-1
Update "Late Binding Closures" section of gotchas.rst
2013-08-14 19:18:08 -07:00
Kenneth Reitz 5a5be7b119 Merge pull request #304 from Duta/patch-1
Update style.rst
2013-08-14 19:17:51 -07:00
Duta 18c3e05e26 Minor wording correction and changed some code-block tags to be python 2013-08-12 13:31:18 +01:00
Duta c666597a73 Update style.rst 2013-08-12 12:44:37 +01:00
claudejrogers 51a727d079 Update "Late Binding Closures" section of gotchas.rst
The late binding closure example seems like a good use case for the
functools.partial function.
2013-08-11 20:35:30 -07:00
kuyan 13d99d95fe Let Sphinx link to Python documentation.
Instead of directly linking to the relevant passages.
2013-08-03 19:28:48 -07:00
kuyan 88fccb1b4d Use code tags where needed. 2013-08-03 19:19:59 -07:00
kuyan 0fd1b7a9ab Use code tags where needed. 2013-08-03 19:12:18 -07:00
kuyan 9072b68de4 more code tags. 2013-07-30 13:39:51 -07:00
kuyan 6753406a40 Declare code block language, fix formatting 2013-07-30 13:19:31 -07:00
kuyan 1a77f1bbec No need to say 'PEP 8' twice. 2013-07-30 13:13:05 -07:00
kuyan d95b26b4e7 Use code tags where needed. 2013-07-30 13:10:46 -07:00
kuyan b6f014342d Use the :pep: tag instead of directly linking PEPs 2013-07-30 13:05:56 -07:00
Matthew Boehm 963ab0aabf Fix enumerate code snippet to run without error message
Code previously added numbers to strings, which results in a TypeError
2013-07-28 10:20:47 -04:00
Roland van Laar 93cb68e308 Fix link to tox documentation. 2013-07-20 09:08:59 +02:00
Kenneth Reitz 12a9eeeca0 Merge pull request #284 from kuyan/master
Grammar, capitalization fixes
2013-07-15 06:27:29 -07:00
Arthur Loder 8d6f737438 minor formatting changes. 2013-06-21 22:35:10 -04:00
Gerald Rich 3b6a7ca913 copy edit structure.rst 2013-06-13 02:25:37 -04:00
kuyan 598c5695b7 Correct spelling of 'aforementioned'. 2013-06-12 19:39:32 -07:00
Dominique Plante b4a08152b7 reapply some improvements to code style section in different branch 2013-05-13 21:37:51 -07:00
Kenneth Reitz fee9fcd990 Merge pull request #261 from ozgur/string_concatenation_note
Note added on string concatenation
2013-04-13 20:24:54 -07:00