Joshua Dong
b61bb7d343
fix minor typos ( #294 )
2017-07-12 11:58:51 -07:00
Nick Coghlan
8350530c12
Cross-reference PEP 3131 from PEP 8 ( #286 )
...
PEP 3131 (Unicode identifiers) includes a policy section
covering their use within the standard library.
This adds an explicit cross-reference to that section from
the prescriptive naming conventions section of PEP 8.
2017-06-06 12:57:48 +10:00
Guido van Rossum
c78ccb3dcb
Clarify my preferences around trailing commas ( #211 )
2017-02-13 21:50:40 -08:00
Ivan Levkivskyi
a919235364
[WIP] Semantics of variance in type variables and notation conventions ( #68 )
...
* Semantics of variance in type variables and notation conventions
* Notation convention for type variables in PEP 8
2016-08-03 11:33:00 -07:00
Marti Raudsepp
04a6af2ab1
Fix various typos, spelling and grammar errors
...
Errors detected using Topy (https://github.com/intgr/topy ), all changes
verified by hand.
2016-07-11 18:35:35 +03:00
Łukasz Langa
b8a510bf29
Clarify backward-compatible type annotations
...
Previous wording used the term "function annotations" which is overly generic. This commit modifies the wording to make it clear we don't mean arbitrary function annotations.
2016-06-20 13:23:55 -07:00
Barry Warsaw
070a23b4a0
Clarify dunders.
2016-06-08 10:43:53 -04:00
Barry Warsaw
0aa70aebf1
Relax __all__ location.
...
Put all module level dunders together in the same location, and remove
the redundant version bookkeeping information.
Closes #27187 . Patch by Ian Lee.
2016-06-07 16:25:19 -04:00
Berker Peksag
efcd31a52f
Issue #27191 : Improve markup of PEP 8, patch by Ian Lee
2016-06-02 19:13:50 -07:00
Serhiy Storchaka
4088a7dddc
Backed out changeset: c4aef26d128b
...
Unknown interpreted text role "kbd".
2016-05-03 14:10:04 +03:00
Serhiy Storchaka
65c6f592cd
Use the kbd role.
2016-05-03 10:47:48 +03:00
Senthil Kumaran
7690a00d47
PEP-8 Update on Knuth style breaking of a long formula. #issue26780
...
Patch by Brandon Rhodes provides clarity and rationale for this suggestion.
Also fixes the example to use "+", "-" operators which have same precedence
level.
Reviewed by Guido van Rossum.
2016-04-19 23:14:50 -07:00
Chris Angelico
2caed0265e
Fix typo, resea[r]ch
2016-04-16 05:23:30 +10:00
Guido van Rossum
21bdcd2e9b
Fix typo. Revert my previous diff that removed another example breaking before "and".
2016-04-15 09:54:42 -07:00
Guido van Rossum
c59c4376ad
According to Knuth, it is better to break *before* a binary operator.
2016-04-15 09:43:52 -07:00
Guido van Rossum
1a6cc45d06
Fix style inconsistency with "and" on continuation line.
2016-04-14 10:21:55 -07:00
Guido van Rossum
e1d8f55b86
Just refer to the spec in PEP 484 for straddling annotations instead of repeating the info in PEP 8.
2016-03-21 13:30:24 -07:00
Barry Warsaw
254ad75c22
Gramatical and other improvements given by thefourtheye.
...
Closes #26408
2016-02-22 09:05:45 -05:00
Guido van Rossum
2d2ea7a703
Clarify that stdlib experiments with annotations are not encouraged.
2016-01-05 15:25:40 -08:00
Ethan Furman
544e54168a
fix grammar
2016-01-05 12:12:27 -08:00
Guido van Rossum
146574f68a
Update rules for function annotations in the light of PEP 484.
2016-01-05 10:33:30 -08:00
Guido van Rossum
8288ff6a15
Update PEP 8 to recommend against trailing whitespace.
2016-01-04 08:59:47 -08:00
Guido van Rossum
e0e78d4b74
Remove outdated motivation for short module names.
2015-10-20 20:24:08 -07:00
Guido van Rossum
9ef9e40080
Separate -> surround.
2015-04-22 14:09:41 -07:00
Guido van Rossum
f80066c3fb
Describe an old but good rule for consistent return statements.
2015-04-06 18:07:10 -07:00
Chris Angelico
f76f34e7f4
Formatting fixes to new PEP8 text
2015-01-03 13:27:29 +11:00
Chris Angelico
44c193d765
Incorporate PEP 8 text from Ian Lee to clarify annotation policy
2015-01-03 13:22:31 +11:00
Benjamin Peterson
48e4630fce
remove trailing ws
2015-01-02 12:10:41 -06:00
Benjamin Peterson
ae0f50ead3
conjugate 'do' correctly ( closes #23149 )
2015-01-02 12:09:41 -06:00
Guido van Rossum
9287cc8ab5
Last patch was by Akira Kitada, not Akira Li.
2014-11-29 19:02:36 -08:00
Guido van Rossum
a4e187da6b
PEP 8 section on string quotes by Akira Li.
2014-11-29 19:01:24 -08:00
Guido van Rossum
d2c09a26cf
Clarify space around colon in slice (severa cases).
2014-08-31 20:18:33 -07:00
Barry Warsaw
422ebe6d79
A few extra clarifications about multiline if and with statements. Also,
...
conform the multiline-if statement conditionals to other recommendations in
the PEP, i.e. that lines in a multiline conditional end with the binary
operator.
2014-08-17 12:24:10 -04:00
Nick Coghlan
a240f27644
PEP 8: try to better explain a somewhat cryptic guideline
2014-08-17 10:41:13 +10:00
Nick Coghlan
4b19deca98
Clarify PEP 8 point about preferring def statements
2014-08-08 21:07:46 +10:00
Barry Warsaw
58cc81fc33
Prefer "is not" over "not ... is". Closes 21540.
2014-05-20 18:14:17 -04:00
Nick Coghlan
65da967dc2
PEP 8: tweak some awkward wording pointed out in private email
2014-05-13 13:36:23 +10:00
Barry Warsaw
13e0bbf3fe
Nice simplification from Nick.
2014-04-27 16:26:18 -04:00
Barry Warsaw
472d1422de
Wording.
2014-04-27 13:37:04 -04:00
Barry Warsaw
eea38be724
Additional clarifications based on discussion amongst the PEP authors.
2014-04-27 13:34:33 -04:00
Guido van Rossum
94af0e93e6
Make PEP 8 follow PEP 257 on docstring endings.
2014-03-02 09:29:33 -08:00
Brett Cannon
f13f2d6ae5
Bring PEP 8 in line with PEP 257
2014-03-01 10:57:51 -05:00
Barry Warsaw
b7879b52e9
Ethan Furman's latest patch for Issue 19331.
2013-11-01 12:56:37 -04:00
Guido van Rossum
fa09420ca3
Merge
2013-08-02 08:13:25 -07:00
Nick Coghlan
f7025e0fcc
Another PEP 8 typo fix
...
Yay for not saving before committing :P
2013-08-02 20:46:19 +10:00
Nick Coghlan
5dbb9a10f1
Tweak source encoding wording
2013-08-02 20:28:35 +10:00
Nick Coghlan
05d72183a8
Fix typo
2013-08-02 20:20:17 +10:00
Nick Coghlan
7de08107a4
Use Guido's preferred wording re: line length
2013-08-02 20:18:45 +10:00
Nick Coghlan
1730f70421
Always defer to project specific guides
2013-08-02 12:30:37 +10:00
Nick Coghlan
ad0edb7348
Additional PEP 8 tweaks
...
- be explicit that project style guides take precedence
- make a line splitting example consistent with other guidelines
- clarify wording of the def-vs-lambda guideline
2013-08-02 12:26:24 +10:00