Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upCreate PEP 8-style document with the intended formatting style explicitly described #53
Comments
|
@ambv Using Black and loving it, are you planning on using Sphinx or something else? Happy to help get things started if Sphinx. |
|
Yes, Sphinx and RTFD would be my first choice :-) |
|
@ambv Can you link to an example of the pep8 style doc that you were thinking? The pep itself or something else. Thanks. |
|
PEP 8 itself is good but wordy. Google Style Guide is also good. |
|
@ambv @carljm Giving some thought to this. In some cases, Original and After Black will be helpful to illustrate what will happen. Initially, I'm starting with something similar to:
My current thinking is that Original/After Black examples will cut down on wordiness in PEP8. Side by side code displays could be cool too. |
See also: - psf/black#429 - psf/black#53 (W503)
See also: - psf/black#429 - psf/black#53 (W503)
See also: - psf/black#429 - psf/black#53 (W503)
See also: - psf/black#429 - psf/black#53 (W503)
See also: - psf/black#429 - psf/black#53 (W503)
See also: - psf/black#429 - psf/black#53 (W503) - cihai/cihai#140
See also: - psf/black#429 - psf/black#53 (W503) - cihai/cihai#140
See also: - cihai/cihai#140 - psf/black#429 - psf/black#53 (W503)
|
@ambv If I understand correctly, this has already been superseded by "The Black Code Style", yes? |
This will help users identify whether what they see is a bug or a feature.
A document like this also helps with giving reasons for specific behavior.