diff options
| author | Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> | 2023-02-06 21:15:37 +0100 |
|---|---|---|
| committer | Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> | 2023-02-06 21:46:38 +0100 |
| commit | 611c5529fce22d700909b0721f83fd1d9cc8d215 (patch) | |
| tree | dee7f3e4c2cf865ebfed0f9cbec8c0bb694c3062 /doc | |
| parent | b05e2c07cf8ab4cef10c64f6b6557659a31fac57 (diff) | |
| download | pylint-git-611c5529fce22d700909b0721f83fd1d9cc8d215.tar.gz | |
Add ``docstring-first-line-empty`` doc example
Co-authored-by: Ollie <46904826+ollie-iterators@users.noreply.github.com>
Diffstat (limited to 'doc')
4 files changed, 20 insertions, 2 deletions
diff --git a/doc/data/messages/d/docstring-first-line-empty/bad.py b/doc/data/messages/d/docstring-first-line-empty/bad.py new file mode 100644 index 000000000..3085bb069 --- /dev/null +++ b/doc/data/messages/d/docstring-first-line-empty/bad.py @@ -0,0 +1,10 @@ +def foo(): # [docstring-first-line-empty] + """ + + Lorem Ipsum is simply dummy text of the printing and typesetting + industry. + + Lorem Ipsum has been the industry's standard dummy text ever since the + 1500s, when an unknown printer took a galley of type and scrambled it + to make a type specimen book + """ diff --git a/doc/data/messages/d/docstring-first-line-empty/details.rst b/doc/data/messages/d/docstring-first-line-empty/details.rst deleted file mode 100644 index ab8204529..000000000 --- a/doc/data/messages/d/docstring-first-line-empty/details.rst +++ /dev/null @@ -1 +0,0 @@ -You can help us make the doc better `by contributing <https://github.com/PyCQA/pylint/issues/5953>`_ ! diff --git a/doc/data/messages/d/docstring-first-line-empty/good.py b/doc/data/messages/d/docstring-first-line-empty/good.py index c40beb573..16fdd55b2 100644 --- a/doc/data/messages/d/docstring-first-line-empty/good.py +++ b/doc/data/messages/d/docstring-first-line-empty/good.py @@ -1 +1,8 @@ -# This is a placeholder for correct code for this message. +def foo(): + """Lorem Ipsum is simply dummy text of the printing and typesetting + industry. + + Lorem Ipsum has been the industry's standard dummy text ever since the + 1500s, when an unknown printer took a galley of type and scrambled it + to make a type specimen book + """ diff --git a/doc/data/messages/d/docstring-first-line-empty/pylintrc b/doc/data/messages/d/docstring-first-line-empty/pylintrc new file mode 100644 index 000000000..c41e21550 --- /dev/null +++ b/doc/data/messages/d/docstring-first-line-empty/pylintrc @@ -0,0 +1,2 @@ +[MAIN] +load-plugins = pylint.extensions.docstyle |