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

Add flake8-rst for docstring code examples #2192

Merged
merged 22 commits into from
Oct 4, 2018
Merged

Add flake8-rst for docstring code examples #2192

merged 22 commits into from
Oct 4, 2018

Conversation

kataev
Copy link
Contributor

@kataev kataev commented Sep 21, 2018

Hello, i'm created new tool flake8-rst.
Idea is simple, crop with regex code snippets and put it in flake8.
PR splitted into logical commits for better review. First commit, add sourcecode:: pycon, next fix found issues.

Copy link
Contributor

@menshikh-iv menshikh-iv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work @kataev 👍 definitely useful addition!

Please also add this check to CI here https://github.com/RaRe-Technologies/gensim/blob/develop/.travis.yml#L16

tox.ini Outdated Show resolved Hide resolved
@menshikh-iv
Copy link
Contributor

menshikh-iv commented Sep 24, 2018

Notes (mostly for me)

  • Choose "good-enough" ignore parameters for config & raise an issue about eliminating part of it (for example, we can't immediately fix all docstrings, some of "undefined name" fix pretty hard). Done
  • Move flake8-doc to python2 (same as flake8 works now), for this, I'm waiting for "python2-compatible" release of flake8-rst from you @kataev Done, now we have checks on 27 and 36
  • Resolve confict & merge PR with the fresh develop Done

Next great step (after this PR) will be #2107, @kataev have you time to help us with it?

@menshikh-iv menshikh-iv changed the title Flake8 on docs code snippets Add flake8 for docstrings Sep 24, 2018
@menshikh-iv menshikh-iv changed the title Add flake8 for docstrings Add flake8-rst for docstring code examples Oct 4, 2018
@menshikh-iv
Copy link
Contributor

menshikh-iv commented Oct 4, 2018

Great work, thanks @kataev 🌟 Congratz with first contribution 🚀

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

Successfully merging this pull request may close these issues.

2 participants