CODEWITHSUNDEEP
python-3.xpylintdocstring
Ravi chandra
Ravi chandra

Reputation: 21

Missing module docstring (missing-module-docstring)

I am running below the addition of two numbers in jupyter

'''
This program `summationoftwonumbers` and displays their results
'''

A = 1

B = 5

print('Sum of Numbers:',A+B)

It is running fine giving an output as "Sum of Numbers: 6"

But when running a file by using PyLint, summationoftwonumber.ipynb gives the below errors.

summationoftwonumbers.ipynb:1:0: C0114: Missing module docstring (missing-module-docstring)
summationoftwonumbers.ipynb:1:0: W0104: Statement seems to have no effect (pointless-statement)

I do not understand why this is happening.

Upvotes: 2

Views: 4846

Answers (1)

Thomas Dignan
Thomas Dignan

Reputation: 7102

It's that you used quotes to write a comment, which in some cases creates a docstring. Python is warning you that the statement has no effect in your program. To get rid of the warning you could rewrite the line:

''' This program summationoftwonumbers and displays their results '''

as a normal comment:

# This program summationoftwonumbers and displays their results

Upvotes: 1

Related Questions