Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create PEP 8-style document with the intended formatting style explicitly described #53

Open
ambv opened this issue Mar 21, 2018 · 6 comments

Comments

@ambv
Copy link
Collaborator

@ambv ambv commented Mar 21, 2018

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.

@ambv ambv created this issue from a note in Amazing documentation (To do) Mar 21, 2018
@willingc
Copy link
Collaborator

@willingc willingc commented Mar 21, 2018

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

@ambv
Copy link
Collaborator Author

@ambv ambv commented Mar 22, 2018

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

@willingc
Copy link
Collaborator

@willingc willingc commented Mar 27, 2018

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

@ambv
Copy link
Collaborator Author

@ambv ambv commented Mar 27, 2018

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

@willingc
Copy link
Collaborator

@willingc willingc commented Mar 30, 2018

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

tony added a commit to tmux-python/libtmux that referenced this issue Aug 25, 2018
tony added a commit to vcs-python/libvcs that referenced this issue Aug 25, 2018
tony added a commit to tmux-python/libtmux that referenced this issue Aug 25, 2018
tony added a commit to vcs-python/vcspull that referenced this issue Aug 25, 2018
tony added a commit to cihai/cihai that referenced this issue Aug 25, 2018
See also:
- psf/black#429
- psf/black#53 (W503)
tony added a commit to cihai/unihan-etl that referenced this issue Aug 25, 2018
tony added a commit to cihai/unihan-db that referenced this issue Aug 25, 2018
tony added a commit to cihai/cihai-cli that referenced this issue Aug 25, 2018
@ambv ambv added the stable label Mar 3, 2020
@ambv ambv added this to To Do in Stable release via automation Mar 3, 2020
@SanketDG
Copy link
Contributor

@SanketDG SanketDG commented May 8, 2020

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Stable release
  
To Do
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
3 participants
You can’t perform that action at this time.