On Wed, Aug 25, 2021 at 10:38 PM Christopher Barker <pythonchb@gmail.com> wrote:
As I was working on removing Python 2 references from PEP 8 (PR: https://github.com/python/peps/pull/2059), I tried to avoid any other copy-editing.

However, I noted a few things that maybe could use some attention:

stdlib or not?
##########

Right at the top, it says:

"This document gives coding conventions for the Python code comprising the standard library in the main Python distribution."

However, it has become a de facto standard for all Python code, and in the document itself, there is frequent wording akin to "Identifiers used in the standard library must be ASCII compatible ...", and even advice for third party libraries.

Which I think is acknowledging that PEP 8 is indeed not only about the standard library.

So maybe there should be a bit of text about that at the top.

I wouldn't be opposed to that personally. I think a lot of people just think PEP 8 is a doc for the community when it is actually for Python itself and it happens to be very convenient for others to use. Although we obviously understand that people do use it in situations outside of the stdlib, so I don't think saying, "if you're going to use this in a way we didn't mean it to, here's some advice".

-Brett
 

Name Mangling
#############

In the sections on "Method Names and Instance Variables" and "Designing for Inheritance", the discussion of name mangling (leading __ names) is a bit redundant. Nothing incorrect or misleading -- just a copy-editing issue.

Maybe I'll do a copy-editing PR ....

-CHB


--
Christopher Barker, PhD (Chris)

Python Language Consulting
  - Teaching
  - Scientific Software Development
  - Desktop GUI and Web Development
  - wxPython, numpy, scipy, Cython
_______________________________________________
Python-Dev mailing list -- python-dev@python.org
To unsubscribe send an email to python-dev-leave@python.org
https://mail.python.org/mailman3/lists/python-dev.python.org/
Message archived at https://mail.python.org/archives/list/python-dev@python.org/message/WCTRPSZSC2XO4NG5CKMOBLK2P7UUY7RE/
Code of Conduct: http://python.org/psf/codeofconduct/