DOC: Fix flake8 issues in doc/source/whatsnew/v0.20.0.rst

[saurav2608]

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.20.0.rst
2. Remove the import block ( from pandas import *) from the lines (8-11) of the file v0.20.0.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.20.0.rst 
source/whatsnew/v0.20.0.rst:69:21: E128 continuation line under-indented for visual indent
source/whatsnew/v0.20.0.rst:93:15: E203 whitespace before ':'
source/whatsnew/v0.20.0.rst:93:37: E203 whitespace before ':'
source/whatsnew/v0.20.0.rst:134:42: E231 missing whitespace after ':'
source/whatsnew/v0.20.0.rst:134:57: E231 missing whitespace after ':'
source/whatsnew/v0.20.0.rst:195:12: E251 unexpected spaces around keyword / parameter equals
source/whatsnew/v0.20.0.rst:195:14: E251 unexpected spaces around keyword / parameter equals
source/whatsnew/v0.20.0.rst:196:14: E251 unexpected spaces around keyword / parameter equals
source/whatsnew/v0.20.0.rst:196:16: E251 unexpected spaces around keyword / parameter equals
source/whatsnew/v0.20.0.rst:197:12: E251 unexpected spaces around keyword / parameter equals
source/whatsnew/v0.20.0.rst:197:14: E251 unexpected spaces around keyword / parameter equals
source/whatsnew/v0.20.0.rst:318:8: E124 closing bracket does not match visual indentation
source/whatsnew/v0.20.0.rst:448:21: E124 closing bracket does not match visual indentation
source/whatsnew/v0.20.0.rst:549:32: E231 missing whitespace after ','
source/whatsnew/v0.20.0.rst:549:34: E231 missing whitespace after ','
source/whatsnew/v0.20.0.rst:620:83: E501 line too long (98 > 79 characters)
source/whatsnew/v0.20.0.rst:711:7: E999 SyntaxError: invalid syntax
source/whatsnew/v0.20.0.rst:877:84: E501 line too long (102 > 79 characters)

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

[WillAyd]

@saurav2608 would be easier if you just use checkboxes in one issue to keep track of all of these. Can probably do so in the issue referenced

[datapythonista]

@WillAyd we've got the issue #24177 to keep track of the changes, but it's useful to have individual issues for each task, so people working on it can comment and them, and avoid duplicate work. Also it makes it easier for first time contributors to have these issues, as they are very clear and specific to what needs to be done.

@saurav2608 what would be good is to add a reference to the parent issue to each issue, and you'll know better, but may be more efficient to have one issue for all the files in one "major" release (e.g. 0.23.*) than one for each minor release (e.g. 0.23.0). This way we have less issues to create, and I think up to 4 files together is still very doable.

[saurav2608]

@datapythonista I am adding a reference to all the individual issues to #24177 . I will keep this in mind while creating the next set of issues. But most of the older whatsnew have multiple flake errors (20s per file). I will try to balance between keeping the PRs small and reduce the no of open issues.

[datapythonista]

It's up to you. But I think we've got a PR that fixed 3 issues, so just letting you know that may be you can create less issues with more files each and save some time. 20 issues are very quick to fix and review.