[Python-Dev] Breaking undocumented API (original) (raw)

Alexander Belopolsky alexander.belopolsky at gmail.com
Tue Nov 16 22:54:24 CET 2010

On Tue, Nov 16, 2010 at 4:31 PM, Ben Finney <ben+python at benfinney.id.au> wrote: ..

I don't know about Guido, but I'd be -1 on suggestions to add more normative information to PEP 7, PEP 8, PEP 257, or any other established style guide PEP. I certainly don't want to have to keep going back to the same documents frequently just to see if the set of recommendations I already know has changed recently.

Rather, I took Guido's mention of "this belongs in a style guide" as suggesting a new style guide. Perhaps one that explicitly obsoletes an existing one or perhaps not; either way, the updated normative recommendations are in a new document with a new name, so that one knows whether one has already read it.

+1

Numbered PEPs, while well-known to old-timers, are really odd place for newcomers to find a style guide. This really should be a separate part at the top level of docs.python.org. Note that we already have a documentation style guide under "Documenting Python." Maybe we should reuse this slot and have say "Python Development" part which will put together PEP 7, PEP 8 and documentation "Style Guide" in one convenient package.

This, however, is a much bigger project than what I had in mind when I started this thread.

More information about the Python-Dev mailing list