Author rhettinger
Recipients SilentGhost, brett.cannon, docs@python, eric.araujo, pitrou, rhettinger
Date 2016-03-23.01:06:04
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1458695165.2.0.906665095317.issue10894@psf.upfronthosting.co.za>
In-reply-to
Content
Much of this is already in PEP 8 and doesn't need repeating.  Also, the tone is somewhat judgmental, heavy handed, restrictive, and over-broad for my tastes.

The last part seems to imply that we're going to change existing code in a way that may break user code.  Our whole goal is to make migrating to Python 3 easier.  The next to last part may create a pressure to document and promise some things that may be implementation specific details.

I think we should let PEP 8 serve as the primary guideline.  For new code, try to be as clear as possible on public versus private.  For existing code, any changes should be considered on a case by case basis to strike the best balance between useful documentation versus over-specification versus breaking existing code by privatizing that which was unintentionally made public.  

Also, when it comes to documentation, there are many things which are public (such as pickling support, every magic method available, etc) which aren't discussed for every single class.  The reason for this is that it tends to fill the documentation with clutter, making it hard for the more useful information to stand out.
History
Date User Action Args
2016-03-23 01:06:05rhettingersetrecipients: + rhettinger, brett.cannon, pitrou, eric.araujo, SilentGhost, docs@python
2016-03-23 01:06:05rhettingersetmessageid: <1458695165.2.0.906665095317.issue10894@psf.upfronthosting.co.za>
2016-03-23 01:06:05rhettingerlinkissue10894 messages
2016-03-23 01:06:04rhettingercreate