Commit Graph

65 Commits

Author SHA1 Message Date
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
Duta c666597a73 Update style.rst 2013-08-12 12:44:37 +01: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 1a77f1bbec No need to say 'PEP 8' twice. 2013-07-30 13:13:05 -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
Arthur Loder 8d6f737438 minor formatting changes. 2013-06-21 22:35:10 -04:00
Dominique Plante b4a08152b7 reapply some improvements to code style section in different branch 2013-05-13 21:37:51 -07:00
Kenneth Reitz c7f1da22a2 Merge pull request #264 from simon-weber/fix-codestyle-typo
Fix typo/links to code_style section
2013-04-03 09:50:02 -07:00
Simon Weber 7cf628d8ea fix links to code_style section 2013-04-03 12:46:48 -04:00
Pascal Borreli 54f1d8ca4d Fixed typos 2013-04-01 19:09:15 +00:00
Kyle Kelley 810956c56b Grammar: plurality fixes, tense fix, typos 2013-03-18 19:06:50 -03:00
Eli 709f8d3451 Fix mispelling 2013-03-08 16:55:48 -05:00
lambdadi 8c15d01979 Fix markdown formatting mistakes
Markdown formatting, for text emphasis and file paths, was broken in my
previous commit to the 'Idioms' section of the style.rst document. My
previous commit may be found at:
https://github.com/kennethreitz/python-guide/pull/243

Sorry!
2013-03-06 14:38:23 +05:30
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