Skip to content

Commit de029c7

Browse files
authored
Added missing-yield-type-doc message example (#6345)
1 parent da72751 commit de029c7

4 files changed

Lines changed: 33 additions & 0 deletions

File tree

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
def even_number_under(n: int): # [missing-yield-type-doc]
2+
"""Prints even numbers smaller than n.
3+
Args:
4+
n: Upper limit of even numbers.
5+
6+
Yields:
7+
even numbers
8+
"""
9+
for i in range(n):
10+
if i % 2 == 1:
11+
continue
12+
yield i
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
This message is raised only when parameter ``accept-no-yields-doc`` is set to ``no``.
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
from typing import Iterator
2+
3+
4+
def even_number_under(n: int) -> Iterator[int]:
5+
"""Prints even numbers smaller than n.
6+
Args:
7+
n: Upper limit of even numbers.
8+
9+
Yields:
10+
even numbers
11+
"""
12+
for i in range(n):
13+
if i % 2 == 1:
14+
continue
15+
yield i
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[master]
2+
load-plugins=pylint.extensions.docparams
3+
4+
[Parameter_documentation]
5+
accept-no-yields-doc=no

0 commit comments

Comments
 (0)