How can I fix `flake8 D100 — Missing docstring` error in atom editor

python atom-editor flake8
Sami Soheili picture Sami Soheili · Sep 13, 2017 · Viewed 7k times · Source

I installed atom for python programming and also installed Linter and flake8 packages but everything I write in text editor I get this warning :

D100 — Missing docstring in public module

I already tried 

 pip uninstall flake8-docstrings
 pip install Flake8-pep257

How can I fix this warning ?

Answer

Rakesh Kumar picture Rakesh Kumar · May 19, 2018

Its nothing but a comment like this on the top of your program. According to Python Documentation it should be there before every function and program. Here is a simple docstring code

"""Return the pathname of the KOS root directory."""

Related questions

Which atom python linting packages are stable?

It seems that there are too many Python linting packages and I am wonder which one should we use. I suspect installing two will provide a confusing experience, if not even triggering weird bugs. python-autopep8 - 20+ linter-python-flaks - 6+ linter-flake8 - 153+ …

Read More
Running Python from Atom

In Sublime, we have an easy and convent way to run Python or almost any language for that matter using ⌘ + b (or ctrl + b) Where the code will run in a small window below the source code and can easily …

Read More
How to configure Atom to run Python3 scripts?

In my terminal, I type $ which python3, outputting /opt/local/bin/python3 I would like to configure Atom to run Python3 scripts. In my Atom Config, I have runner: python: "/opt/local/bin/python3" However, if I run the following …

Read More