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

Missing docstring in public module error D100 #170

Closed
epicallan opened this issue Mar 12, 2016 · 17 comments
Closed

Missing docstring in public module error D100 #170

epicallan opened this issue Mar 12, 2016 · 17 comments
Labels

Comments

@epicallan
Copy link

I keep getting this error despite having added a module doc string. I have flake8 docstrings 0.2.5 installed

@Arcanemagus
Copy link
Member

Have you tried flake8-pep257? One of them has an issue with stdin input, and from your issue I'm guessing it's flake8-docstrings.

@epicallan
Copy link
Author

yes thats is what is installed, so should I downgrade or upgrade to another version??

@Arcanemagus
Copy link
Member

Those are two different packages, which do you have installed?

@epicallan
Copy link
Author

I have flake8 , flake8-docstrings and hacking installed via pip

@Arcanemagus
Copy link
Member

Do you still see this if you run the following?

pip uninstall flake8-docstrings
pip install flake8-pep257

@epicallan
Copy link
Author

yes still get the error after running the above.

@nikaro
Copy link

nikaro commented Jul 27, 2016

Since yesterday i got this error too. I think that flake8 received an update recently, may be it comes from there.

flake8==3.0.2
flake8-docstrings==1.0.2

PS: flake8-pep257 seems obsolete.

@Arcanemagus
Copy link
Member

Do you see the same when you do cat foo.py | flake8 -?

@nikaro
Copy link

nikaro commented Jul 28, 2016

Yes i see the same with this command. It's strange that with flake8 foo.py it outputs nothing… :-/

So it's a bug in flake8[-docstrings] ?

@Arcanemagus
Copy link
Member

Most likely it's the same bug that just has never been fixed.

From what I understand processing stdin input follows a completely different path, and breaks somewhat easily with plugins to flake8.

@Arcanemagus
Copy link
Member

Marking this as closed, it's an external issue that we have no control over here.

@mlalkaka
Copy link

For reference, this is the external bug logged to fix this issue in the flake8-docstrings repository: Issue #13: D100 is triggered when reading from stdin.

@jay0lu
Copy link

jay0lu commented Jan 20, 2017

To fixed the warning, I installed flake8-pep257.
pip install flake8-pep257

@mlalkaka
Copy link

I tried running pip install flake8-pep257, but that didn't help. It looks like flake8-pep257 and pep257 have been renamed to flake8-docstrings and pydocstyle, respectively. So I don't think there should be a need for flake8-pep257 anymore anyway.

@Arcanemagus
Copy link
Member

@mlalkaka flake8-docstrings is a different module from flake8-pep257, not a rename.

@mlalkaka
Copy link

Oh, sorry about that, I was incorrect. It looks like only pep257 was renamed to pydocstyle. The packages flake8-docstrings and flake8-pep257 are independent, but there haven't been updates to flake8-pep257 in a while.

@Arcanemagus
Copy link
Member

Yea, and unfortunately both have had alternating issues with working properly, and at the moment I'm not sure which, if either, actually works.

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

No branches or pull requests

5 participants