How do you fix "Missing module docstringpylint(missing-module-docstring)"

Question

I'm using the pygame module on VS Code and I ran into the issue where the pygame has not init member. I followed the solutions to this link. I edited the user settings and added

"python.linting.pylintArgs": [
    "--extension-pkg-whitelist=pygame",
    "--unsafe-load-any-extension=y"
]

to the end of the json file

The pygame problem was resolved. However, when I use import random. I get this warning:

Missing module docstringpylint(missing-module-docstring)

How do I make it go away? Also, is there a better way to resolve the init problem of pygame?

I think the warning missing doc string is from your py file not from import random. Try adding some doc string at the top of your file describing what the .py file is for. — Mahesh Anakali, Jan 29 '21 at 05:47

score 35 · Answer 1 · answered Mar 20 '21 at 19:49

A python module's docstring documents what the contents of that file are for.

You can solve this error by adding a docstring at the top of the module:

"""
Provides some arithmetic functions
"""

def add(a, b):
  """Add two numbers"""
  return a + b

def mult(a, b): 
  """Multiply two numbers"""
  return a * b

Read more at https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings

score 21 · Accepted Answer · answered Jan 29 '21 at 08:34

21

I just figured out what docstrings are. They just describe the function or class. It's enclosed in three double quotation marks or single quotation marks. This helped me.

To remove docstring warnings in VSCode, I just added "--disable=C0111" to "python.linting.pylintArgs": [], which was in the User's JSON settings.

answered Jan 29 '21 at 08:34

Kyle Angelo Gonzales

812
1
4
18

4

For your reference: `C0114 (missing-module-docstring); C0115 (missing-class-docstring) C0116 (missing-function-docstring)`. Also you can mark your reply as an answer for more people who have the same question to reach this solution. – Molly Wang-MSFT Jan 29 '21 at 08:52

score 5 · Answer 3 · edited Jan 02 '23 at 22:15

5

I added the settings below in VsCode to disable all the docstring warnings.

"python.linting.pylintArgs": [
  "--disable=missing-module-docstring",
  "--disable=missing-class-docstring",
  "--disable=missing-function-docstring"
]

edited Jan 02 '23 at 22:15

sajeyks mwangi

549
8
20

answered Oct 07 '22 at 11:32

ikhvjs

5,316
2
13
36

score 0 · Answer 4 · answered Feb 28 '22 at 20:19

This error is coming out when we are using pylint in the directory that doesn't have .pylintrc. Go to directory which has .pylintrc and run from there.

Example:

test/ test1.py test2/test2.py .pylintrc

If you want to run pylint for test2.py inside test/test2 then you will get that error.

test/test2$ pylint test2.py  is wrong.

test$ pylint test2.py is correct.

score 0 · Answer 5 · answered Aug 02 '23 at 18:27

This Answer is updated with the docs of the extension add below code in vscode's settings.json

"pylint.args": [
    "--disable=missing-module-docstring",
    "--disable=missing-class-docstring",
    "--disable=missing-function-docstring"
],

this will disable the warnings for module, class and function docstring

ref: extension's docs

How do you fix "Missing module docstringpylint(missing-module-docstring)"

5 Answers5

Linked