diff options
| author | Matus Valo <matusvalo@gmail.com> | 2022-04-15 15:59:54 +0200 |
|---|---|---|
| committer | Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> | 2022-04-19 15:00:34 +0200 |
| commit | 7de265a7e692d77cc25c9cc91e0f85e7dc5459ef (patch) | |
| tree | 4ef1dade2a56e7f5e43b52c566a4899b73b0302d | |
| parent | 2f2f73e292731b42fb4c0f48df3dcf46e2b735e6 (diff) | |
| download | pylint-git-7de265a7e692d77cc25c9cc91e0f85e7dc5459ef.tar.gz | |
Added missing-param-doc message example
| -rw-r--r-- | doc/data/messages/m/missing-param-doc/bad.py | 6 | ||||
| -rw-r--r-- | doc/data/messages/m/missing-param-doc/good.py | 8 |
2 files changed, 14 insertions, 0 deletions
diff --git a/doc/data/messages/m/missing-param-doc/bad.py b/doc/data/messages/m/missing-param-doc/bad.py new file mode 100644 index 000000000..e362f8649 --- /dev/null +++ b/doc/data/messages/m/missing-param-doc/bad.py @@ -0,0 +1,6 @@ +def integer_sum(a, b): # [missing-param-doc] + """Returns sum of two integers + :param a: first integer + :type a: int + """ + return a + b diff --git a/doc/data/messages/m/missing-param-doc/good.py b/doc/data/messages/m/missing-param-doc/good.py new file mode 100644 index 000000000..f90ec9d35 --- /dev/null +++ b/doc/data/messages/m/missing-param-doc/good.py @@ -0,0 +1,8 @@ +def integer_sum(a, b): + """Returns sum of two integers + :param a: first integer + :type a: int + :param b: second integer + :type b: int + """ + return a + b |