Commit Graph

148 Commits

Author SHA1 Message Date
Simon Weber 7cf628d8ea fix links to code_style section 2013-04-03 12:46:48 -04:00
Kyle Kelley 7a1077a464 dos2unix for writing/structure 2013-03-23 00:07:12 -04:00
Kyle Kelley 8e9a21e17e Bye bye dos newlines 2013-03-23 00:04:43 -04:00
Kyle Kelley 810956c56b Grammar: plurality fixes, tense fix, typos 2013-03-18 19:06:50 -03: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
Eli 709f8d3451 Fix mispelling 2013-03-08 16:55:48 -05:00
Kenneth Reitz b3146b58cc Merge pull request #244 from mkomitee/master
ctrl-v is not a comment toggle in vim
2013-03-06 09:47:56 -08: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
Kenneth Reitz d950093e81 Merge pull request #249 from barisumog/master
minor typos and omitted words
2013-03-04 15:39:49 -08: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
barisumog a0761200eb minor typo 2013-03-01 11:15:55 +02:00
barisumog f7c306e206 minor typos 2013-03-01 11:13:33 +02:00
barisumog df402a1c8e minor typo in documentation.rst 2013-03-01 11:04:24 +02:00
barisumog 9f5bf3078f minor typo in reading.rst 2013-03-01 10:59:01 +02:00
barisumog 528a915e08 minor typos in style.rst 2013-03-01 10:55:48 +02:00
Michael Komitee a6f9cc3508 Removing inaccurate statement
ctrl-v in vim activates visual block mode. visual block mode can be used to
insert a comment character, but is not itself a comment toggle.
2013-02-03 21:47:03 -05: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
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
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
Julian Berman ad4819476f Add doctests and switch to using headings. 2012-12-23 18:06:14 -05: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
Kenneth Reitz 4248d135f3 Merge pull request #224 from Julian/gotchas
Started writing about common gotchas with two quick examples
2012-12-21 12:53:56 -08:00
Mark Veronda be9a256367 Fixed some type-os 2012-12-07 16:55:03 -05:00
Julian Berman 4675c91fc5 Late binding closures 2012-12-04 00:41:43 -05:00
Julian Berman fd9f0db1ce First gotcha. 2012-12-04 00:41:43 -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
Kenneth Reitz 2a7c0912d8 Merge pull request #210 from artiegold/master
Fix "it's".
2012-11-15 17:21:27 -08:00
Chris Warrick bbfa479227 Fix a tiny typo 2012-11-11 21:04:00 +01:00
Artie Gold ffdde4ac3e Small text fix. It's "its" not "it's" here. 2012-10-28 15:53:36 -05: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
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
Harold Cooper 0d4865ed66 use double-underscore for temporary variable, as encouraged elsewhere in this file 2012-10-07 12:41:50 -07:00
Johannes 852edbee25 Fix typo 2012-10-06 12:49:08 +02:00
Clint Howarth b8a41ac61f build out header matter, clean up formatting 2012-09-22 23:51:59 -04:00
Kenneth Reitz af72128ab9 Merge pull request #197 from mindsocket/master
Add mock library to testing page
2012-09-22 18:48:46 -07:00
Clint Howarth 29af1a2097 tighten, de-dup PEP8 content, improve formatting/organization 2012-09-22 08:19:00 -04:00
Roger Barnes 3b902fe090 Add examples to section on mock 2012-09-19 16:46:54 +10:00
Roger Barnes b96b11fe59 Add mock library to testing page 2012-09-18 21:04:14 +10:00
silkuze f2ca4ea7c6 Missing a semicolon in the function definition 2012-09-08 15:23:39 +03: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
Kenneth Reitz bbb1c2ea19 Revert "Fix spelling in structure.rst"
This reverts commit 0ff26166c6.
2012-07-08 15:48:56 -04:00