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

flake8-rst 0.4.3 config? #23665

Closed
TomAugspurger opened this issue Nov 13, 2018 · 6 comments · Fixed by #23699
Closed

flake8-rst 0.4.3 config? #23665

TomAugspurger opened this issue Nov 13, 2018 · 6 comments · Fixed by #23699
Labels
CI Continuous Integration Docs
Milestone

Comments

@TomAugspurger
Copy link
Contributor

With flake8-rst 0.4.2 the output of flake8-rst doc/source --filename="*.rst" is clean.

With 0.4.3, I see a bunch of failures like

doc/source/install.rst:226:14: E999 SyntaxError: invalid syntax
doc/source/sparse.rst:9:4: E402 module level import not at top of file
doc/source/sparse.rst:10:4: E402 module level import not at top of file
doc/source/sparse.rst:10:4: F401 'pandas.util.testing as tm' imported but unused
doc/source/sparse.rst:97:21: E702 multiple statements on one line (semicolon)
doc/source/sparse.rst:247:41: E127 continuation line over-indented for visual indent
doc/source/comparison_with_r.rst:8:4: F401 'numpy as np' imported but unused
doc/source/comparison_with_r.rst:9:31: E225 missing whitespace around operator
doc/source/comparison_with_r.rst:169:6: E121 continuation line under-indented for hanging indent
doc/source/comparison_with_r.rst:169:14: E231 missing whitespace after ','

cc @datapythonista will we need some excludes in the flake8-rst section of setup.cfg?

@TomAugspurger TomAugspurger added Docs CI Continuous Integration labels Nov 13, 2018
@TomAugspurger TomAugspurger added this to the Contributions Welcome milestone Nov 13, 2018
@datapythonista
Copy link
Member

Is the CI already failing? If it's not I'd create an issue (or few if there are many errors) to fix those, and tag it as "good first issue". I'm sure we'll get them fixed in couple of days.

@TomAugspurger
Copy link
Contributor Author

TomAugspurger commented Nov 13, 2018 via email

@datapythonista
Copy link
Member

Wouldn't it be simpler to pin flake8-rst to 0.4.2 while we fix the errors?

Btw, how did you install 0.4.3? I'm happy to create the issues myself, but want to explain in them how to install it easily, so new contributors can get the list, and make sure everything is fixed before sending the PR.

@TomAugspurger
Copy link
Contributor Author

TomAugspurger commented Nov 13, 2018 via email

@datapythonista
Copy link
Member

Oh, only 2390 errors, I understand why you thought on ignoring instead of fixing.

I think in flake-rst 0.4.3 the .. ipython:: directive starts to be checked, that wasn't in 0.4.2.

@FHaase do you want to take care of this? I'd say the best would be to create start adding one issue per file with clear instructions on what to do. If you mention me in the issue, I'll tag them as "good first issue", and I'm sure some people will be happy to help with those (I think it's too much work for a single person).

@FHaase
Copy link
Contributor

FHaase commented Nov 14, 2018

Well I've asked to just pin the version because the plugin will cover more examples in the future and breaking the CI.

Currently I'm enhancing the plugin so we could get rid of general F821 ignoring. So my plan is to improve the plugin and then create a PR with the updated doc myself.

In the meantime pinning the version would be strongly advised.

@jreback jreback modified the milestones: Contributions Welcome, 0.24.0 Nov 14, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Continuous Integration Docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants