Skip to content

DOC: Fix flake8 issues in doc/source/whatsnew/v0.17.*.rst #24235

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
saurav2608 opened this issue Dec 11, 2018 · 2 comments · Fixed by #24340
Closed

DOC: Fix flake8 issues in doc/source/whatsnew/v0.17.*.rst #24235

saurav2608 opened this issue Dec 11, 2018 · 2 comments · Fixed by #24340

Comments

@saurav2608
Copy link

xref: #24177

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.

Two steps are required to replicate the issue

  1. Edit setup.cfg in the pandas home, and in the flake8-rst section, remove from the exclude list the file doc/source/whatsnew/v0.17.0.rst & doc/source/whatsnew/v0.17.1.rst
  2. Remove the import block ( from pandas import *) from the lines (8-11) of the file v0.17.*.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/whatsnew/v0.17.*
doc/source/whatsnew/v0.17.0.rst:83:23: E203 whitespace before ':'
doc/source/whatsnew/v0.17.0.rst:83:47: E231 missing whitespace after ','
doc/source/whatsnew/v0.17.0.rst:84:23: E203 whitespace before ':'
doc/source/whatsnew/v0.17.0.rst:84:47: E231 missing whitespace after ','
doc/source/whatsnew/v0.17.0.rst:84:57: E231 missing whitespace after ','
doc/source/whatsnew/v0.17.0.rst:85:23: E203 whitespace before ':'
doc/source/whatsnew/v0.17.0.rst:85:47: E231 missing whitespace after ','
doc/source/whatsnew/v0.17.0.rst:85:57: E231 missing whitespace after ','
doc/source/whatsnew/v0.17.0.rst:110:39: E231 missing whitespace after ','
doc/source/whatsnew/v0.17.0.rst:110:49: E231 missing whitespace after ','
doc/source/whatsnew/v0.17.0.rst:115:39: E231 missing whitespace after ','
doc/source/whatsnew/v0.17.0.rst:115:49: E231 missing whitespace after ','
doc/source/whatsnew/v0.17.0.rst:122:31: E231 missing whitespace after ','
doc/source/whatsnew/v0.17.0.rst:122:41: E231 missing whitespace after ','
doc/source/whatsnew/v0.17.0.rst:123:31: E231 missing whitespace after ','
doc/source/whatsnew/v0.17.0.rst:123:41: E231 missing whitespace after ','
doc/source/whatsnew/v0.17.0.rst:141:25: E203 whitespace before ':'
doc/source/whatsnew/v0.17.0.rst:141:47: E231 missing whitespace after ','
doc/source/whatsnew/v0.17.0.rst:141:55: E231 missing whitespace after ','
...
doc/source/whatsnew/v0.17.1.rst:82:11: F821 undefined name 'DataFrame'
doc/source/whatsnew/v0.17.1.rst:82:25: E203 whitespace before ':'
doc/source/whatsnew/v0.17.1.rst:82:35: E226 missing whitespace around arithmetic operator

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.
cc: @datapythonista

@aqurilla
Copy link
Contributor

Can I work on this issue?

@datapythonista
Copy link
Member

please, go ahead

aqurilla added a commit to aqurilla/pandas that referenced this issue Dec 18, 2018
aqurilla added a commit to aqurilla/pandas that referenced this issue Jan 1, 2019
@jreback jreback added this to the 0.24.0 milestone Jan 1, 2019
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.

4 participants