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

DOC: Fix flake8 issues in doc/source/dsintro.rst #24175

Closed
datapythonista opened this issue Dec 9, 2018 · 0 comments · Fixed by #24187
Closed

DOC: Fix flake8 issues in doc/source/dsintro.rst #24175

datapythonista opened this issue Dec 9, 2018 · 0 comments · Fixed by #24187

Comments

@datapythonista
Copy link
Member

We didn't start validating the format of PEP8 and other code standards in the documentation examples until recently. We still have some files with errors, that we need to skip, and that we should fix, so we can start validating them.

The first step of this issue would be edit setup.cfg in the pandas home, and in the flake8-rst section, remove from the exclude list the file doc/source/dsintro.rst

After that, running the next command will report the errors in the file (note that syntax error usually prevent to validate other errors, and the list of errors to fix can become much longer when the syntax error is fixed (please make sure that you are using flake8-rst version 0.7.0 or higher):

$ flake8-rst doc/source/dsintro.rst 
doc/source/dsintro.rst:74:12: E203 whitespace before ':'
doc/source/dsintro.rst:74:21: E203 whitespace before ':'
doc/source/dsintro.rst:74:30: E203 whitespace before ':'
doc/source/dsintro.rst:95:12: E203 whitespace before ':'
doc/source/dsintro.rst:95:22: E203 whitespace before ':'
doc/source/dsintro.rst:95:32: E203 whitespace before ':'
doc/source/dsintro.rst:307:15: E203 whitespace before ':'
doc/source/dsintro.rst:308:15: E203 whitespace before ':'
doc/source/dsintro.rst:337:14: E203 whitespace before ':'
doc/source/dsintro.rst:338:14: E203 whitespace before ':'
doc/source/dsintro.rst:349:44: E231 missing whitespace after ','
doc/source/dsintro.rst:349:56: E231 missing whitespace after ','
doc/source/dsintro.rst:350:17: E231 missing whitespace after ','
doc/source/dsintro.rst:350:20: E231 missing whitespace after ','
doc/source/dsintro.rst:350:33: E231 missing whitespace after ','
doc/source/dsintro.rst:350:36: E231 missing whitespace after ','
doc/source/dsintro.rst:511:28: E251 unexpected spaces around keyword / parameter equals
doc/source/dsintro.rst:511:30: E251 unexpected spaces around keyword / parameter equals
doc/source/dsintro.rst:519:27: E251 unexpected spaces around keyword / parameter equals
doc/source/dsintro.rst:519:29: E251 unexpected spaces around keyword / parameter equals
doc/source/dsintro.rst:519:41: W504 line break after binary operator
doc/source/dsintro.rst:535:27: E251 unexpected spaces around keyword / parameter equals
doc/source/dsintro.rst:535:29: E251 unexpected spaces around keyword / parameter equals
doc/source/dsintro.rst:536:27: E251 unexpected spaces around keyword / parameter equals
doc/source/dsintro.rst:536:29: E251 unexpected spaces around keyword / parameter equals
doc/source/dsintro.rst:708:27: E203 whitespace before ':'
doc/source/dsintro.rst:708:44: E203 whitespace before ':'
doc/source/dsintro.rst:708:56: E202 whitespace before '}'
doc/source/dsintro.rst:709:27: E203 whitespace before ':'
doc/source/dsintro.rst:709:44: E203 whitespace before ':'
doc/source/dsintro.rst:709:56: E202 whitespace before '}'
doc/source/dsintro.rst:749:30: E231 missing whitespace after ','
doc/source/dsintro.rst:780:13: W605 invalid escape sequence '\.'
doc/source/dsintro.rst:801:38: E261 at least two spaces before inline comment
doc/source/dsintro.rst:809:12: E225 missing whitespace around operator
doc/source/dsintro.rst:809:40: E231 missing whitespace after ','
doc/source/dsintro.rst:813:40: E231 missing whitespace after ','
doc/source/dsintro.rst:816:40: E231 missing whitespace after ','
doc/source/dsintro.rst:836:29: E203 whitespace before ':'
doc/source/dsintro.rst:837:29: E203 whitespace before ':'
doc/source/dsintro.rst:846:18: E225 missing whitespace around operator
doc/source/dsintro.rst:846:22: E225 missing whitespace around operator
doc/source/dsintro.rst:846:22: E999 SyntaxError: invalid syntax
doc/source/dsintro.rst:893:19: E203 whitespace before ':'
doc/source/dsintro.rst:894:19: E203 whitespace before ':'
doc/source/dsintro.rst:950:53: E231 missing whitespace after ','
doc/source/dsintro.rst:950:70: E231 missing whitespace after ','
doc/source/dsintro.rst:950:72: E231 missing whitespace after ','
doc/source/dsintro.rst:950:74: E231 missing whitespace after ','
doc/source/dsintro.rst:950:77: E231 missing whitespace after ','
doc/source/dsintro.rst:950:80: E231 missing whitespace after ','
doc/source/dsintro.rst:950:82: E231 missing whitespace after ','
doc/source/dsintro.rst:950:83: E501 line too long (85 > 79 characters)
doc/source/dsintro.rst:950:84: E231 missing whitespace after ','
doc/source/dsintro.rst:951:26: E203 whitespace before ':'

Once all the errors are addressed, please open a pull request with the fixes in the file, and removing the file from setup.cfg. If you need to do something that feels wrong to fix an error, please ask in a comment to this issue. Please avoid other unrelated changes, which can be addressed in a separate pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant