Commit Graph

50 Commits

Author SHA1 Message Date
Kenneth Reitz 9178fdfd2c Merge pull request #243 from lambdadi/master
Suggest improved introduction to Style/#Idioms
2013-03-04 15:41:21 -08:00
barisumog 528a915e08 minor typos in style.rst 2013-03-01 10:55:48 +02:00
lambdadi 0e989d75f3 Suggest improved introduction to Style/#Idioms
My reading, though limited, suggests that the general notion of Idioms
is used often, but rarely explained. It feels very alien to beginners. A
term like "Idiomatic Python" can cause mental stack overflow. It did to
me :) So I humbly submit, in this case, explicit is better than
implicit. I debated whether to place it at the top of the document,
where idioms are first mentioned, but placed it here instead, as this
section explicitly references the topic of idioms.
2013-01-30 18:23:08 +05:30
David Echols 7d22f84ff9 Added new Reading section.
If readability is so important to python, why don't python guides have a
list of recommended awesome code to read? Why don't they explain that
code? The idea behind this reading section is to provide such a guide.
The idea here is to start with something small and useful, with a vision
for the future, and iterate quickly.
2013-01-26 11:42:42 -08:00
Jeroen Van Goey 65c5fb6280 Update docs/writing/style.rst
rpartition() takes a seperator as argument
2013-01-11 10:17:50 +01:00
Kenneth Reitz 3a83001855 Merge pull request #223 from Julian/master
Removed a Confusing Example from the Style Article
2012-12-21 12:54:09 -08:00
Mark Veronda be9a256367 Fixed some type-os 2012-12-07 16:55:03 -05:00
Julian Berman 0ea7091a30 Removed tuple example from style guide. 2012-12-03 21:56:22 -05:00
Alex Gaynor e66b3f1a38 Remove a paragraph that wasn't adding value
In addition to be totally wrong about __init__, the description of generators was confusing (and more or less wrong).
2012-11-20 01:51:02 -06:00
Kenneth Reitz 53aa1851c4 Merge pull request #205 from hrldcpr/master
consistent use of double-underscore for throwaway variable
2012-11-15 17:23:06 -08:00
Kenneth Reitz cefa740985 Merge pull request #207 from andrewmacgregor/master
Fixes for warnings in docs
2012-11-15 17:22:15 -08:00
Chris Warrick bbfa479227 Fix a tiny typo 2012-11-11 21:04:00 +01:00
Andrew Macgregor 655c1bdac9 provide valid link for YAGNI 2012-10-16 23:19:54 +08:00
Andrew Macgregor f0834bcfaf Conventions header was throwing inconsistent level warning. Fixed this and later headings to match rest of page. 2012-10-16 22:21:32 +08:00
Harold Cooper 0d4865ed66 use double-underscore for temporary variable, as encouraged elsewhere in this file 2012-10-07 12:41:50 -07:00
Kenneth Reitz dc3af98a38 Merge pull request #183 from thomasballinger/spelling-fix
Spelling fixes in style guide
2012-07-28 13:58:20 -07:00
Thomas Ballinger 96fb1d42d1 remove slashes in code sample in style guide 2012-07-05 14:55:00 -04:00
Thomas Ballinger a8e36af3ea fix grammar issues with style guide 2012-07-05 14:47:47 -04:00
Thomas Ballinger 0a045fdf78 Fix spelling in style guide 2012-07-05 14:25:25 -04:00
Ryan Campbell e3eac0c78c Fix spelling in style.rst 2012-07-03 21:55:49 -06:00
guibog 810c637f6c Adding a bit about returning values 2012-06-24 22:31:09 +08:00
guibog 513bb5fe51 Adding nested unpacking 2012-06-24 21:47:24 +08:00
Kenneth Reitz 911865980b #168 2012-06-09 01:08:55 -04:00
lepture e54f0c3376 fix writing style line continuations to fit pep8 2012-06-09 12:53:29 +08:00
David Winterbottom 4f4825a5b7 Fixed a few grammatical errors. Removed some needless words. 2012-06-08 17:24:13 +02: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
guibog 7cec41a89a Add a block about function arguments 2012-05-16 22:59:13 +08:00
Vincent Noel 489d97e357 Missing double quote 2012-05-03 18:05:29 +03:00
Kenneth Reitz 8311ad2ad6 Merge pull request #52 from epequeno/master
Added idioms to style.rst
2012-04-27 11:36:59 -07: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
guibog f860d3e982 add line continuations in style 2012-04-21 22:43:54 +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
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
Kevin Burke d5a5e545c7 add examples of python idioms. 2012-03-16 01:11:42 -07:00
Dan Crosta 8587cf6a95 per feedback from @ejucovy, warn about shadowing gettext with "_" 2012-03-14 16:10:32 -07:00
Dan Crosta 3268aff854 some idioms I used this morning 2012-03-14 16:09:56 -07:00
Kevin Burke 07ace6f29a lead in to command 2012-03-13 00:10:22 -07:00
Kevin Burke 5464ab3c8d refactor the style page. 2012-03-13 00:09:13 -07:00
Estevan Pequeno d3dbd65547 Update docs/writing/style.rst 2011-12-30 11:38:13 -06:00
Estevan Pequeno b147a1c490 Update docs/writing/style.rst 2011-12-30 11:02:43 -06:00
John Del Rosario 32f664aa3d Add full Zen of Python in Code Style section. 2011-12-31 00:46:52 +08:00
Kamil Kisiel 422ba2e6bd Wrote up the idioms section 2011-12-23 14:33:27 -08:00
Kenneth Reitz 9b8af20caf massive refactor 2011-04-23 16:39:47 -04:00