From 254b260255e21f5bf7e3d10b82322a420df3cb85 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dani=C3=ABl=20van=20Noord?= <13665637+DanielNoord@users.noreply.github.com> Date: Fri, 8 Jul 2022 22:57:00 +0200 Subject: Allow lists of default values in parameter documentation for ``Numpy`` (#7149) --- pylint/extensions/_check_docs_utils.py | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) (limited to 'pylint') diff --git a/pylint/extensions/_check_docs_utils.py b/pylint/extensions/_check_docs_utils.py index 3f4937f17..747fcb4ea 100644 --- a/pylint/extensions/_check_docs_utils.py +++ b/pylint/extensions/_check_docs_utils.py @@ -728,11 +728,22 @@ class NumpyDocstring(GoogleDocstring): re.X | re.S | re.M, ) + re_default_value = r"""((['"]\w+\s*['"])|(True)|(False)|(None))""" + re_param_line = re.compile( rf""" - \s* (\*{{0,2}}\w+)(\s?(:|\n)) # identifier with potential asterisks - \s* (?:({GoogleDocstring.re_multiple_type})(?:,\s+optional)?\n)? # optional type declaration - \s* (.*) # optional description + \s* (\*{{0,2}}\w+)(\s?(:|\n)) # identifier with potential asterisks + \s* + ( + ( + ({GoogleDocstring.re_multiple_type}) # default type declaration + (,\s+optional)? # optional 'optional' indication + )? + ( + {{({re_default_value},?\s*)+}} # set of default values + )? + \n)? + \s* (.*) # optional description """, re.X | re.S, ) -- cgit v1.2.1