From e42119f44481229f46a80f390429d2a114d062f4 Mon Sep 17 00:00:00 2001 From: Matus Valo Date: Fri, 15 Apr 2022 16:13:47 +0200 Subject: [PATCH 1/3] Added missing-raises-doc message example --- doc/data/messages/m/missing-raises-doc/bad.py | 10 ++++++++++ doc/data/messages/m/missing-raises-doc/good.py | 11 +++++++++++ 2 files changed, 21 insertions(+) create mode 100644 doc/data/messages/m/missing-raises-doc/bad.py create mode 100644 doc/data/messages/m/missing-raises-doc/good.py diff --git a/doc/data/messages/m/missing-raises-doc/bad.py b/doc/data/messages/m/missing-raises-doc/bad.py new file mode 100644 index 0000000000..deb84b3767 --- /dev/null +++ b/doc/data/messages/m/missing-raises-doc/bad.py @@ -0,0 +1,10 @@ +def integer_sum(a, b): # [missing-raises-doc] + """Returns sum of two integers + :param a: first integer + :type a: int + :param b: second integer + :type b: int + """ + if not (isinstance(a, int) and isinstance(b, int)): + raise ValueError('Function supports only integer parameters.') + return a + b diff --git a/doc/data/messages/m/missing-raises-doc/good.py b/doc/data/messages/m/missing-raises-doc/good.py new file mode 100644 index 0000000000..88b4f4942e --- /dev/null +++ b/doc/data/messages/m/missing-raises-doc/good.py @@ -0,0 +1,11 @@ +def integer_sum(a, b): + """Returns sum of two integers + :param a: first integer + :type a: int + :param b: second integer + :type b: int + :raises ValueError: One of parameters is not an integer. + """ + if not (isinstance(a, int) and isinstance(b, int)): + raise ValueError('Function supports only integer parameters.') + return a + b From 9a30274eed5de1a1b61e987c89a14056d6351d7d Mon Sep 17 00:00:00 2001 From: Matus Valo Date: Tue, 19 Apr 2022 22:53:11 +0200 Subject: [PATCH 2/3] Migrated to type annotations --- doc/data/messages/m/missing-raises-doc/bad.py | 4 +--- doc/data/messages/m/missing-raises-doc/good.py | 4 +--- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/doc/data/messages/m/missing-raises-doc/bad.py b/doc/data/messages/m/missing-raises-doc/bad.py index deb84b3767..9a59fea88b 100644 --- a/doc/data/messages/m/missing-raises-doc/bad.py +++ b/doc/data/messages/m/missing-raises-doc/bad.py @@ -1,9 +1,7 @@ -def integer_sum(a, b): # [missing-raises-doc] +def integer_sum(a: int, b: int): # [missing-raises-doc] """Returns sum of two integers :param a: first integer - :type a: int :param b: second integer - :type b: int """ if not (isinstance(a, int) and isinstance(b, int)): raise ValueError('Function supports only integer parameters.') diff --git a/doc/data/messages/m/missing-raises-doc/good.py b/doc/data/messages/m/missing-raises-doc/good.py index 88b4f4942e..7e13268f49 100644 --- a/doc/data/messages/m/missing-raises-doc/good.py +++ b/doc/data/messages/m/missing-raises-doc/good.py @@ -1,9 +1,7 @@ -def integer_sum(a, b): +def integer_sum(a: int, b: int): """Returns sum of two integers :param a: first integer - :type a: int :param b: second integer - :type b: int :raises ValueError: One of parameters is not an integer. """ if not (isinstance(a, int) and isinstance(b, int)): From 13988ff89833887d0307b7c7558804237c7471f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Noord?= <13665637+DanielNoord@users.noreply.github.com> Date: Tue, 19 Apr 2022 23:10:00 +0200 Subject: [PATCH 3/3] Update doc/data/messages/m/missing-raises-doc/good.py --- doc/data/messages/m/missing-raises-doc/good.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/data/messages/m/missing-raises-doc/good.py b/doc/data/messages/m/missing-raises-doc/good.py index 7e13268f49..c274493ea6 100644 --- a/doc/data/messages/m/missing-raises-doc/good.py +++ b/doc/data/messages/m/missing-raises-doc/good.py @@ -2,7 +2,7 @@ def integer_sum(a: int, b: int): """Returns sum of two integers :param a: first integer :param b: second integer - :raises ValueError: One of parameters is not an integer. + :raises ValueError: One of the parameters is not an integer. """ if not (isinstance(a, int) and isinstance(b, int)): raise ValueError('Function supports only integer parameters.')