Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Linter does not recognize same docstring issues as flake8 on command line

See original GitHub issue

On Atom version 1.0.5

The linter always raises “D100 - Missing docstring in public module” even if said docstring is present, but does not raise any other valid docstring warnings.

Example:

vs.

ff/team/__init__.py:5:1: D101 Missing docstring in public class
ff/team/__init__.py:12:1: D102 Missing docstring in public method
ff/team/__init__.py:18:1: D105 Missing docstring in magic method

Issue Analytics

State:
Created 8 years ago
Comments:20 (10 by maintainers)

Top GitHub Comments

5reactions

jay0lucommented, Jan 20, 2017

I installed flake8-pep257, and the warning gone. pip install flake8-pep257

2reactions

dragonxlwangcommented, Nov 30, 2015

thanks! after uninstall flake8-docstrings and install flake8-pep257:

$ flake8 --version
2.5.0 (pep8: 1.5.7, pyflakes: 1.0.0, flake8-pep257: 1.0.5, mccabe: 0.3.1) CPython 2.7.10 on Darwin

I can confirm that the problem seems no longer present.

$ cat dep_w2v.py | flake8 -
stdin:2:1: F401 'nltk' imported but unused
stdin:8:1: F401 'numpy' imported but unused
stdin:9:1: F401 'sys' imported but unused
stdin:25:1: D103 Missing docstring in public function
stdin:38:1: D103 Missing docstring in public function
stdin:53:1: D103 Missing docstring in public function
stdin:62:1: D103 Missing docstring in public function
stdin:77:1: D103 Missing docstring in public function
stdin:98:1: D103 Missing docstring in public function
stdin:109:1: D103 Missing docstring in public function
stdin:124:5: F841 local variable 'W' is assigned to but never used
stdin:131:1: D103 Missing docstring in public function

Top Results From Across the Web

Atom package linter-flake8 not showing output - Stack Overflow

I have installed linter-flake8 with Atom on MacOSX. Atom automatically installed linter. My problem is that the package doesn't detect any ...

flake8 Documentation - Read the Docs

This allows you to let pyflakes know about builtins that it may not immediately recognize so it does not report warnings for using...

Full Listing of Options and Their Descriptions - Flake8

This allows you to let pyflakes know about builtins that it may not immediately recognize so it does not report warnings for using...

Flake8 :: CC 410 Textbook

Let's look at this command and see what it does: python3 -m flake8 - as always, we'll execute Flake8 as a module using...

Linting Python in Visual Studio Code

The linter has not been installed in the current Python environment. Open a command prompt, navigate to the location where your selecter interpreter...