Skip to content

Line Length Specification in Contributing Documentation #27232

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

Closed
WillKoehrsen opened this issue Jul 4, 2019 · 2 comments
Closed

Line Length Specification in Contributing Documentation #27232

WillKoehrsen opened this issue Jul 4, 2019 · 2 comments

Comments

@WillKoehrsen
Copy link

Reading the contributing documentation section on pep8, I noticed the acceptable line-length for Python code is given as 79 characters as specified in pep8.

we restrict line-length to 79 characters to promote readability

However, looking at setup.cfg, I see that the maximum line length is specified as 88 characters and flake8 is set up to ignore line length errors.

[flake8]
max-line-length = 88
ignore =
    E501,  # longer line length

Is the contributing documentation out-of-date, or am I making an incorrect interpretation of setup.cfg?

@WillKoehrsen WillKoehrsen changed the title Line Length in Contributing Documentation Line Length Specification in Contributing Documentation Jul 4, 2019
@jreback
Copy link
Contributor

jreback commented Jul 4, 2019

setup.cfg should be changed (this was changed previously but not changed back), PR welcome

black enforces this now so the flake check doesn’t really do anything (for like length)

@jorisvandenbossche
Copy link
Member

I opened #27226 for updating the contributing guide (and initial PR: #27233)

@jorisvandenbossche jorisvandenbossche added this to the No action milestone Jul 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants