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/visualization.rst #24181

Closed
datapythonista opened this issue Dec 9, 2018 · 3 comments · Fixed by #24186
Closed

DOC: Fix flake8 issues in doc/source/visualization.rst #24181

datapythonista opened this issue Dec 9, 2018 · 3 comments · Fixed by #24186

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/visualization.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/visualization.rst 
doc/source/visualization.rst:132:22: E225 missing whitespace around operator
doc/source/visualization.rst:132:22: E999 SyntaxError: invalid syntax
doc/source/visualization.rst:132:26: E225 missing whitespace around operator
doc/source/visualization.rst:166:25: E702 multiple statements on one line (semicolon)ator

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.

@addisonlynch
Copy link
Contributor

Will take this one as well.

@addisonlynch
Copy link
Contributor

addisonlynch commented Dec 9, 2018

@datapythonista would you like me to finish the rest of the issues which are not yet taken and create a single PR (#24185) for them? Looks like

enhancingperf.rst
dsintro.rst
10min.rst

@datapythonista
Copy link
Member Author

Please take one at a time from the issues list. May be simpler for you to address all them at the same time, but makes our life more complicated when reviewing and merging.

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.

3 participants