We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 80ddc28 commit b5d64d3Copy full SHA for b5d64d3
4 files changed
doc/data/messages/m/missing-return-doc/bad.py
@@ -0,0 +1,6 @@
1
+def integer_sum(a: int, b: int): # [missing-return-doc]
2
+ """Returns sum of two integers
3
+ :param a: first integer
4
+ :param b: second integer
5
+ """
6
+ return a + b
doc/data/messages/m/missing-return-doc/details.rst
@@ -0,0 +1 @@
+This message is raised only when parameter ``accept-no-return-doc`` is set to ``no``.
doc/data/messages/m/missing-return-doc/good.py
@@ -0,0 +1,7 @@
+def integer_sum(a: int, b: int) -> int:
+ :return: sum of parameters a and b
7
doc/data/messages/m/missing-return-doc/pylintrc
@@ -0,0 +1,5 @@
+[master]
+load-plugins=pylint.extensions.docparams
+
+[Parameter_documentation]
+accept-no-return-doc=no
0 commit comments