375 Commits

Author SHA1 Message Date
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
David Winterbottom 4f4825a5b7 Fixed a few grammatical errors. Removed some needless words. 2012-06-08 17:24:13 +02:00
John Gabriele 837bcc7370 Added info on the two general types of FLOSS licenses, and changed "restricted"/"permissive". 2012-06-07 11:53:05 -04:00
ncoghlan 1f3fdc51cd Recommend the use of double underscore throwaway variables 2012-05-30 21:43:24 +10: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
Kenneth Reitz 8fb35b9eff Merge pull request #149 from alekzvik/master
Added a note about readthedocs.org at the documenting section
2012-05-19 21:48:03 -07:00
Kenneth Reitz 57e73661c8 Merge pull request #151 from guibog/master
Add a block about function arguments
2012-05-16 14:21:53 -07:00
Ben Tappin 85ed464107 Capitalisation: 'a python project' -> 'a Python project' 2012-05-16 18:53:36 +02:00
guibog 7cec41a89a Add a block about function arguments 2012-05-16 22:59:13 +08:00
Alex Vykalyuk 3874e1f1be Fixed a typo. 2012-05-15 20:09:48 +03:00
Alex Vykalyuk 44b8f5dbf2 Added a note about readthedocs.org at the documneting section 2012-05-15 00:56:49 +03:00
Kenneth Reitz 18b8e123cc Merge pull request #148 from okin/master
Extending documentation tools: Epydoc
2012-05-12 13:38:29 -07:00
Niko Wenselowski 23370fa83a Make the inline link to docstrings work. 2012-05-12 22:05:31 +02:00
Niko Wenselowski 89f9147aec Added document ref to Sphinx. Inserted links at the Epydoc text. 2012-05-12 22:00:46 +02:00
Niko W a0b76ae6ff Added paragraph about Epydoc. 2012-05-12 20:54:40 +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
Jay Roberts 947bdef1c2 Fix minor spelling, grammar, and consistency errors in the Structure is Key section. 2012-05-11 14:08:08 -04:00
Niko Wenselowski 39103d0ad5 Fix small markup error. 2012-05-10 21:57:07 +03:00
Kenneth Reitz 95c010dace Merge pull request #134 from guibog/master
Adding decorators, typing and (im)mutability
2012-05-09 11:03:39 -07:00
Vincent Noel 489d97e357 Missing double quote 2012-05-03 18:05:29 +03:00
guibog d62b2d74f4 Adding decorators, typing and (im)mutability 2012-05-01 22:57:34 +08:00
Kenneth Reitz 8311ad2ad6 Merge pull request #52 from epequeno/master
Added idioms to style.rst
2012-04-27 11:36:59 -07:00
guibog b1bb63071f About OOP 2012-04-27 22:40:21 +08:00
guibog 61e948e887 Clarifying a bit on commented code 2012-04-27 21:40:25 +08:00
guibog 68fc11453a Add on documentation and comments 2012-04-25 23:17:40 +08:00
guibog 8ad935e609 About module and packages in Structure 2012-04-24 22:44:30 +08:00
Kenneth Reitz 9ecebd541b Merge pull request #125 from benregn/master
Source formatting
2012-04-23 12:14:38 -07:00
Tomas Thor Jonsson 70ca1a8cef lines less than 80 chars in /writing/ 2012-04-23 20:24:39 +02:00
guibog 15de2679a3 Adding some generalities to Style 2012-04-23 23:11:34 +08:00
Kenneth Reitz 911d8299e0 Merge pull request #119 from guibog/master
Adding a reference section with a new book and line continuation style guide.
2012-04-22 17:51:56 -07:00
Juarez Bochi 1fb99e5242 Fixed some typos in writing/tests 2012-04-21 17:39:23 -03:00
guibog 2d48df09fc Adding poor project structuration examples 2012-04-21 23:40:35 +08:00
guibog f860d3e982 add line continuations in style 2012-04-21 22:43:54 +08:00
guibog 9944385417 Adding a bunch on unit tests 2012-04-21 21:35:04 +08:00
guibog 6ccfb2fff5 Adding a sample and explanation for doctests 2012-04-21 19:42:37 +08:00
guibog 6e9b37cc37 add some explanations to style guide 2012-04-21 18:15:10 +08:00
William Ting 6e2bd3e7cf Fix list manipulation comments and for loop 2012-04-17 00:06:21 -10:00
Trey Hunner aeb8a0b51f pocco was renamed to pycco 2012-04-03 22:32:30 -07:00
Lee Trout e9339cca50 Corrected atter typo in style. 2012-03-25 13:28:53 -03:00
Lee Trout 7ad589a03c Updated value checking in style guide with more explicit example for None. 2012-03-25 13:25:00 -03:00
Lee Trout b80f05a16e Added missing call to enumerate. 2012-03-25 13:07:09 -03:00
Kenneth Reitz a26f75e158 Merge pull request #101 from kevinburke/style
Clean up the style page
2012-03-16 01:18:34 -07:00