Skip to content
This repository has been archived by the owner on Aug 7, 2023. It is now read-only.

Include docstring errors #73

Merged
merged 3 commits into from
Sep 14, 2015
Merged

Include docstring errors #73

merged 3 commits into from
Sep 14, 2015

Conversation

Arcanemagus
Copy link
Member

Add capturing of docstring errors from the flake8-pep257 extension to flake8.

Fixes #72.

Add capturing of docstring errors from the `flake8-pep257` extension to
`flake8`.
Turns out the docstring extension adds an extra space before the
message, modified the regex to consume that.
@Arcanemagus
Copy link
Member Author

As a note, only flake8-docstrings has the extra space. flake8-pep257 doesn't.

Also, at least on my setup, flake8-docstrings doesn't actually extend flake8 when it is ran from within Atom, so it will not show any errors even with this fix. flake8-pep257 works just fine when ran from either the command line or within Atom.

@Arcanemagus
Copy link
Member Author

Turns out flake8-docstrings doesn't work with stdin input (issue), so for the moment flake8-pep257 is the only working plugin (at least on Windows).

@badray
Copy link
Contributor

badray commented Aug 28, 2015

Hi! Thanks for your work! But unfortunately I can't do anything with this merge(Review, eventualy merge and release) until sunday 30.08. Having crunch time in my work till then :/.

Please keep in mind that I want to avoid speed-release, like 1.6.0.

@Arcanemagus
Copy link
Member Author

@badray do you have time to review this? There are now merge conflicts (another prefix was added) as this sat for so long.

@steelbrain
Copy link
Contributor

@badray I think I'll take this one if you don't mind

@steelbrain steelbrain assigned steelbrain and unassigned badray Sep 14, 2015
@steelbrain
Copy link
Contributor

LGTM Thanks!

steelbrain added a commit that referenced this pull request Sep 14, 2015
@steelbrain steelbrain merged commit 8cc0316 into AtomLinter:master Sep 14, 2015
@Arcanemagus Arcanemagus deleted the include-docstrings branch September 14, 2015 19:08
@cemsbr
Copy link
Contributor

cemsbr commented Nov 11, 2015

I'm having this issue. This is the CLI output:

asyncshell/executor.py:1:1: D100  Missing docstring in public module
asyncshell/executor.py:4:1: D101  Missing docstring in public class
asyncshell/executor.py:7:1: D102  Missing docstring in public method
asyncshell/executor.py:13:1: D102  Missing docstring in public method
asyncshell/executor.py:17:1: D102  Missing docstring in public method
asyncshell/executor.py:20:1: D102  Missing docstring in public method

@steelbrain
Copy link
Contributor

@cemsbr it should work https://regex101.com/r/sD2kT8/1

@cemsbr
Copy link
Contributor

cemsbr commented Nov 11, 2015

I tried to restart, disable and enable, without success...

@Arcanemagus
Copy link
Member Author

As it looks like you should already have switched over to flake8-docstrings at the time you made that comment can you please file a new issue about that so we can debug what is going wrong for you there?

@cemsbr
Copy link
Contributor

cemsbr commented Nov 12, 2015

Thank you. New issue: #112

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

Successfully merging this pull request may close these issues.

4 participants