Commit Graph

108 Commits

Author SHA1 Message Date
Simeon Visser 71187f4274 Changed python into Python where needed 2014-05-25 20:58:19 +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
Zearin cc7b19356e Mark up files & directories 2014-04-11 11:26:37 -04:00
imranghory 21d8f91ac6 Make explicit whats being referred to 2014-01-25 14:37:18 +00:00
Pengkui Luo 83630edf35 typos 2013-11-02 06:19:56 -05: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 9072b68de4 more code tags. 2013-07-30 13:39:51 -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
Gerald Rich 3b6a7ca913 copy edit structure.rst 2013-06-13 02:25:37 -04:00
Özgür Vatansever 328df72c4f code block newline added 2013-03-31 22:19:16 +03:00
Özgür Vatansever 425d6155e0 note added on string concatenation 2013-03-31 18:23:42 +03:00
Kyle Kelley 7a1077a464 dos2unix for writing/structure 2013-03-23 00:07:12 -04:00
Kyle Kelley bc7799d1fa Separate join and list comprehension 2013-03-18 18:48:45 -03:00
Kyle Kelley b9b50213bb Quick grammar fix 2013-03-18 18:46:08 -03:00
Kyle Kelley 1fb50a3999 Made more direct and concise
The guide is opinionated, and that's ok.
2013-03-18 18:30:05 -03:00
gurpinars 3ac59eb08c modified structure.rst 2013-03-04 22:17:09 +02:00
gurpinars 6a5341cfce added further reading in structure.rst 2013-03-04 22:10:22 +02:00
Lambda Adi d00182b541 Clarified point about variable names
"Avoid using variables for different things" is misleading at best. The
point must communicate that foolish reuse of _the same_ variable name,
for different types of data, is the hobgoblin of reckless minds :)
2013-01-27 15:04:09 +05:30
Kenneth Reitz cefa740985 Merge pull request #207 from andrewmacgregor/master
Fixes for warnings in docs
2012-11-15 17:22:15 -08:00
Artie Gold ffdde4ac3e Small text fix. It's "its" not "it's" here. 2012-10-28 15:53:36 -05:00
Andrew Macgregor f1651e1dc8 looks like a typo, was perhaps meant to be link to decorators but that is only a few lines later 2012-10-16 22:04:15 +08:00
Johannes 852edbee25 Fix typo 2012-10-06 12:49:08 +02:00
silkuze f2ca4ea7c6 Missing a semicolon in the function definition 2012-09-08 15:23:39 +03:00
Kenneth Reitz bbb1c2ea19 Revert "Fix spelling in structure.rst"
This reverts commit 0ff26166c6.
2012-07-08 15:48:56 -04:00
Estevan Pequeno 9f792956db small edit 2012-07-05 01:59:25 -05:00
Estevan Pequeno 80a12a70ff markup fix 2012-07-05 01:57:37 -05:00
Kenneth Reitz 4461f0ce8e Merge pull request #178 from epequeno/modulename
Add stub, naming restrictions to structure
2012-07-03 23:33:13 -07:00
Ryan Campbell 0ff26166c6 Fix spelling in structure.rst 2012-07-03 21:48:42 -06:00
Estevan Pequeno 28d211f6f5 edit stub 2012-07-03 22:36:07 -05:00
Estevan Pequeno 167d566650 add stub 2012-07-03 22:19:31 -05:00
Estevan Pequeno fcefab992c minor editing 2012-07-03 21:24:08 -05:00
Estevan Pequeno f05bad3839 module naming 2012-07-03 21:08:42 -05:00
Ian Cordasco 226ad55c51 Improve upon string concatenation section. 2012-06-15 14:08:38 -04:00
Kyle Roberts 62e59a57e4 Add code example to demonstrate proper string concatenation.
The text does a good job of explaining which route to take when
concatenating strings, but the mention of "join" might mean nothing to
beginners without a concrete example.
2012-06-13 21:34:08 -04:00
Philip Deuchler 1d1727e658 Removed 'more likely to be' when describing a pure function's deterministic attributes, as pure functions by definition are deterministic 2012-06-08 11:29:57 -04:00
Andrea Gelmini 80d65f1f47 Fix uppercase after semicolon 2012-05-27 17:36:18 +02:00
Natan L 305c69be1d Solidified sanctity of sentences. 2012-05-19 22:15:04 -07:00
Ben Tappin 85ed464107 Capitalisation: 'a python project' -> 'a Python project' 2012-05-16 18:53:36 +02:00
Kenneth Reitz a8b764ecd2 Merge pull request #147 from okin/master
Consistent syntax highlighting.
2012-05-12 07:24:53 -07:00
Niko W 0c9090878f Consistent code highlighting. 2012-05-12 11:16:30 +02:00
Jay Roberts 90b12de0bd Fix minor spelling, grammar, and consistency errors in the Mutable and immutable types. 2012-05-11 14:48:32 -04:00
Jay Roberts a27f9d25a8 Fix minor spelling, grammar, and consistency errors in the Dynamic Typing section. 2012-05-11 14:46:07 -04:00
Jay Roberts 2dd87bea16 Fix minor spelling, grammar, and consistency errors in the Decorators section. 2012-05-11 14:39:58 -04:00
Jay Roberts cca9272a7f Fix minor spelling, grammar, and consistency errors in the Object-oriented programming section.
The paragraph about context and side effects was very difficult to
parse and contained the word "decelable". I attempted to capture the
meaning of the paragraph in a way that was more readable.
2012-05-11 14:37:56 -04:00
Jay Roberts e79aa476a0 Fix minor spelling, grammar, and consistency errors in the Packages section. 2012-05-11 14:24:49 -04:00
Jay Roberts 13865eecae Fix minor spelling, grammar, and consistency errors in the Modules section. 2012-05-11 14:20:14 -04:00