Black: Create PEP 8-style document with the intended formatting style explicitly described

[ambv]

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.

[willingc]

@ambv Using Black and loving it, are you planning on using Sphinx or something else? Happy to help get things started if Sphinx.

[ambv]

Yes, Sphinx and RTFD would be my first choice :-)

[willingc]

@ambv Can you link to an example of the pep8 style doc that you were thinking? The pep itself or something else. Thanks.

[ambv]

PEP 8 itself is good but wordy. Google Style Guide is also good.

[willingc]

@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:

• Guide contents: https://test-black.readthedocs.io/en/style-guide/style_guide/style_guide.html
• Rule example: https://test-black.readthedocs.io/en/style-guide/style_guide/guards.html

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.

[SanketDG]

@ambv If I understand correctly, this has already been superseded by "The Black Code Style", yes?

[mcsitter]

The Black code style appears to b quite complete. Are there things missing?