Commit Graph

139 Commits

Author SHA1 Message Date
Mark Amery acda0d1dde PEP 0008: Clarify self-contradictory =-spacing rules (#820)
Previously, the PEP contained roughly the following three rules, in sequence:

1. Never use spaces around `=` when used to indicate a parameter default
2. Something unrelated
3. DO use spaces around `=` when used to indicate a parameter default if there is also a parameter annotation present

This commit attempts to clarify this part of the PEP by:
* Combining the first and third rules listed above into a single rule that addresses both annotated and unannotated parameters
* Rephrasing the first rule to indicate that it applies only to unannotated parameters, to eliminate the logical contradiction
2018-10-29 10:52:27 -07:00
Géry Ogam 3714aa1cef PEP 8: Fix inconsistent use of line breaks, case and indentation (#664) 2018-07-07 16:20:37 -07:00
Géry Ogam 108b2f9da2 Use consistent "backwards" adverb and case for heads (#637) 2018-05-24 11:53:55 -07:00
Ivan Levkivskyi a81f56f751 Add coding style recommendations for variable annotations (#548) 2018-01-18 19:33:13 -08:00
Carl-Ty e0436e9f3c PEP 8 Explicitly State Variable Names convention? #535 (#545) 2018-01-17 15:56:23 -08:00
James Ray 07b66af4f3 abbreviation -> acronym (#517) 2017-12-19 13:05:09 -08:00
Mariatta cf3bad5ab3
Revert "Rename all .txt PEP files to .rst (GH-462)" (GH-464)
This reverts commit bb0e518ed3.
2017-11-11 11:28:55 -08:00
Huang Huang bb0e518ed3 Rename all .txt PEP files to .rst (GH-462)
For https://github.com/python/peps/issues/1
2017-11-11 10:30:43 -08:00
Mariatta 2c212e0086
PEP 8, deindent some of the text. (GH-458) 2017-11-10 09:22:07 -08:00
toonarmycaptain ef1eb2f868 Update pep-0008.txt (#438)
* Update pep-0008.txt

Clarified contradictions regarding comment formatting. NB Complete sentences should have a period.

* Update pep-0008.txt

Changed to remove reference to short comments without terminating period.

* Update pep-0008.txt

Further refined, corrected incorrect, fixed  singular/plural.

* Update pep-0008.txt

* Update pep-0008.txt

Edit for consistency use 'multi-' in 'multi-line` 'multi-statement` 'multi-sentence` etc with dash rather than space or no splitter (eg 'multi line`, 'multiline`). If a different convention is preferred, do that.

* Update pep-0008.txt 'latin' capitalization

'Latin' is a proper noun, and thus should be capitalized.

* Update pep-0008.txt 'boolean' capitalization

Capitalization should be consisted. I propose 'boolean' should always be capitalized, as per https://english.stackexchange.com/questions/4481/should-the-word-boolean-be-capitalized

At present it is inconsistently capitalised.
Changed 'boolean' to 'Boolean'

* Update pep-0008.txt - 'unicode' capitalization

Update pep-0008.txt - as a proper noun, 'unicode' should be capitalized. Fixed 3 instances.

* Revise Update pep-0008.txt

Removed revisions to 'boolean', 'unicode'. 

Unicode capitalization [issue](https://bugs.python.org/issue31873) under discussion.

* Removed trailing newlines

Removed trailing newlines

* Standardised 'multiline', reworded 'Latin'

Made the form 'multiline' uniform throughout the document. 

Clarified references to Latin alphabet to direct to the specific character set desired.

* Removed errant period

* Moved  'alphabet'

Moved  'alphabet' before encoding parenthesis line 336.
2017-11-05 16:52:16 -08:00
toonarmycaptain baef778005 Update pep-0008.txt (#433)
Update pep-0008.txt

Clarified contradictions regarding comment formatting. NB Complete sentences should have a period.
2017-10-25 11:28:55 -04:00
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