Skip to content

Commit 2cef5d3

Browse files
committed
Fixed bad function params
1 parent f8a25e1 commit 2cef5d3

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docstring.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ def get_docstring_args(fd, file_name, func_name, class_name=None):
1010
Extract docstring parameters from function definition
1111
"""
1212
docstring = ast.get_docstring(fd)
13-
if len(re.findall(r"Parameters", docstring)) != 1:
13+
if docstring is None or len(re.findall(r"Parameters", docstring)) != 1:
1414
msg = "Missing required 'Parameters' section in docstring in \n"
1515
msg += f"file: {file_name}\n"
1616
if class_name is not None:
@@ -46,7 +46,7 @@ def check_args(doc_args, sig_args, file_name, func_name, class_name=None):
4646
"""
4747
Compare docstring arguments and signature argments
4848
"""
49-
diff_args = signature_args.difference(docstring_args)
49+
diff_args = sig_args.difference(doc_args)
5050
if len(diff_args) > 0:
5151
msg = "Found one or more arguments/parameters with missing docstring in \n"
5252
msg += f"file: {file_name}\n"

0 commit comments

Comments
 (0)