From 010d2dd3c3d7845d6356773fda9968c5b92d8cc9 Mon Sep 17 00:00:00 2001 From: Matus Valo Date: Fri, 15 Apr 2022 16:18:28 +0200 Subject: [PATCH 1/5] Added missing-yield-type-doc message example --- doc/data/messages/m/missing-yield-type-doc/bad.py | 12 ++++++++++++ doc/data/messages/m/missing-yield-type-doc/good.py | 12 ++++++++++++ 2 files changed, 24 insertions(+) create mode 100644 doc/data/messages/m/missing-yield-type-doc/bad.py create mode 100644 doc/data/messages/m/missing-yield-type-doc/good.py diff --git a/doc/data/messages/m/missing-yield-type-doc/bad.py b/doc/data/messages/m/missing-yield-type-doc/bad.py new file mode 100644 index 0000000000..5546136a33 --- /dev/null +++ b/doc/data/messages/m/missing-yield-type-doc/bad.py @@ -0,0 +1,12 @@ +def even_number_under(n: int): # [missing-yield-type-doc] + """Prints even numbers smaller than n. + Args: + n (int): Upper limit of even numbers. + + Yields: + even numbers + """ + for i in range(n): + if i % 2 == 1: + continue + yield i diff --git a/doc/data/messages/m/missing-yield-type-doc/good.py b/doc/data/messages/m/missing-yield-type-doc/good.py new file mode 100644 index 0000000000..0382d50180 --- /dev/null +++ b/doc/data/messages/m/missing-yield-type-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 From 8d04d8dbb1b7726fa1fbc4d95f37b32aa857f416 Mon Sep 17 00:00:00 2001 From: Matus Valo Date: Fri, 15 Apr 2022 17:23:02 +0200 Subject: [PATCH 2/5] Add pylintrc file --- doc/data/messages/m/missing-yield-type-doc/pylintrc | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 doc/data/messages/m/missing-yield-type-doc/pylintrc diff --git a/doc/data/messages/m/missing-yield-type-doc/pylintrc b/doc/data/messages/m/missing-yield-type-doc/pylintrc new file mode 100644 index 0000000000..1416fbd0bf --- /dev/null +++ b/doc/data/messages/m/missing-yield-type-doc/pylintrc @@ -0,0 +1,5 @@ +[master] +load-plugins=pylint.extensions.docparams + +[Parameter_documentation] +accept-no-yields-doc=no From f901263099e474d2a992512a985d64aea3103149 Mon Sep 17 00:00:00 2001 From: Matus Valo Date: Fri, 15 Apr 2022 21:33:32 +0200 Subject: [PATCH 3/5] Added details.rst --- doc/data/messages/m/missing-yield-type-doc/details.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 doc/data/messages/m/missing-yield-type-doc/details.rst diff --git a/doc/data/messages/m/missing-yield-type-doc/details.rst b/doc/data/messages/m/missing-yield-type-doc/details.rst new file mode 100644 index 0000000000..1965b1b9a4 --- /dev/null +++ b/doc/data/messages/m/missing-yield-type-doc/details.rst @@ -0,0 +1 @@ +This message is raised only when parameter ``accept-no-yields-doc`` is set to ``no``. From 019ff1262bc11e279d853df53206caece22d7191 Mon Sep 17 00:00:00 2001 From: Matus Valo Date: Tue, 19 Apr 2022 23:04:26 +0200 Subject: [PATCH 4/5] Migrate to type annotations --- doc/data/messages/m/missing-yield-type-doc/bad.py | 2 +- doc/data/messages/m/missing-yield-type-doc/good.py | 8 +++++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/data/messages/m/missing-yield-type-doc/bad.py b/doc/data/messages/m/missing-yield-type-doc/bad.py index 5546136a33..a417275d5f 100644 --- a/doc/data/messages/m/missing-yield-type-doc/bad.py +++ b/doc/data/messages/m/missing-yield-type-doc/bad.py @@ -1,7 +1,7 @@ def even_number_under(n: int): # [missing-yield-type-doc] """Prints even numbers smaller than n. Args: - n (int): Upper limit of even numbers. + n: Upper limit of even numbers. Yields: even numbers diff --git a/doc/data/messages/m/missing-yield-type-doc/good.py b/doc/data/messages/m/missing-yield-type-doc/good.py index 0382d50180..b85f77e739 100644 --- a/doc/data/messages/m/missing-yield-type-doc/good.py +++ b/doc/data/messages/m/missing-yield-type-doc/good.py @@ -1,10 +1,12 @@ -def even_number_under(n: int): +from typing import Iterator + +def even_number_under(n: int) -> Iterator[int]: """Prints even numbers smaller than n. Args: - n (int): Upper limit of even numbers. + n: Upper limit of even numbers. Yields: - int: even numbers + even numbers """ for i in range(n): if i % 2 == 1: From 6ac96394a8431a30ac49ae6a8bed86bdb1611035 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Tue, 19 Apr 2022 21:09:17 +0000 Subject: [PATCH 5/5] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- doc/data/messages/m/missing-yield-type-doc/good.py | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/data/messages/m/missing-yield-type-doc/good.py b/doc/data/messages/m/missing-yield-type-doc/good.py index b85f77e739..f9cb9fdfd9 100644 --- a/doc/data/messages/m/missing-yield-type-doc/good.py +++ b/doc/data/messages/m/missing-yield-type-doc/good.py @@ -1,5 +1,6 @@ from typing import Iterator + def even_number_under(n: int) -> Iterator[int]: """Prints even numbers smaller than n. Args: