Skip to content

Commit

Permalink
gh-106368: Argument clinic: improve coverage for self.valid_line()
Browse files Browse the repository at this point in the history
…calls (#107641)
  • Loading branch information
AlexWaygood committed Aug 4, 2023
1 parent 904b531 commit 2c25bd8
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 3 deletions.
32 changes: 32 additions & 0 deletions Lib/test/test_clinic.py
Original file line number Diff line number Diff line change
Expand Up @@ -1057,6 +1057,38 @@ def test_explicit_parameters_in_docstring(self):
Okay, we're done here.
""")

def test_docstring_with_comments(self):
function = self.parse_function(dedent("""
module foo
foo.bar
x: int
# We're about to have
# the documentation for x.
Documentation for x.
# We've just had
# the documentation for x.
y: int
# We're about to have
# the documentation for foo.
This is the documentation for foo.
# We've just had
# the documentation for foo.
Okay, we're done here.
"""))
self.checkDocstring(function, """
bar($module, /, x, y)
--
This is the documentation for foo.
x
Documentation for x.
Okay, we're done here.
""")

def test_parser_regression_special_character_in_parameter_column_of_docstring_first_line(self):
function = self.parse_function(dedent("""
module os
Expand Down
4 changes: 1 addition & 3 deletions Tools/clinic/clinic.py
Original file line number Diff line number Diff line change
Expand Up @@ -4685,9 +4685,7 @@ def state_modulename_name(self, line: str) -> None:
# this line is permitted to start with whitespace.
# we'll call this number of spaces F (for "function").

if not self.valid_line(line):
return

assert self.valid_line(line)
self.indent.infer(line)

# are we cloning?
Expand Down

0 comments on commit 2c25bd8

Please sign in to comment.