diff options
| author | Matus Valo <matusvalo@gmail.com> | 2022-04-15 16:17:25 +0200 |
|---|---|---|
| committer | Daniël van Noord <13665637+DanielNoord@users.noreply.github.com> | 2022-04-19 23:07:31 +0200 |
| commit | 52334748ce2ca90c1ef29356988c9d8e7452fb09 (patch) | |
| tree | 3cbf03f1f250933f03742ebfe881834ae2b305c9 | |
| parent | 6b25ff0ad360dd1265a22c396428d2c66960cbcc (diff) | |
| download | pylint-git-52334748ce2ca90c1ef29356988c9d8e7452fb09.tar.gz | |
Added missing-yield-doc message example
| -rw-r--r-- | doc/data/messages/m/missing-yield-doc/bad.py | 9 | ||||
| -rw-r--r-- | doc/data/messages/m/missing-yield-doc/good.py | 12 |
2 files changed, 21 insertions, 0 deletions
diff --git a/doc/data/messages/m/missing-yield-doc/bad.py b/doc/data/messages/m/missing-yield-doc/bad.py new file mode 100644 index 000000000..e4d9341a6 --- /dev/null +++ b/doc/data/messages/m/missing-yield-doc/bad.py @@ -0,0 +1,9 @@ +def even_number_under(n: int): # [missing-yield-doc] + """Prints even numbers smaller than n. + Args: + n (int): Upper limit of even numbers. + """ + for i in range(n): + if i % 2 == 1: + continue + yield i diff --git a/doc/data/messages/m/missing-yield-doc/good.py b/doc/data/messages/m/missing-yield-doc/good.py new file mode 100644 index 000000000..0382d5018 --- /dev/null +++ b/doc/data/messages/m/missing-yield-doc/good.py @@ -0,0 +1,12 @@ +def even_number_under(n: int): + """Prints even numbers smaller than n. + Args: + n (int): Upper limit of even numbers. + + Yields: + int: even numbers + """ + for i in range(n): + if i % 2 == 1: + continue + yield i |