Skip to content
This repository was archived by the owner on Nov 3, 2023. It is now read-only.

Commit a0c68ab

Browse files
committed
tweak internal documentation for Sphinx-style D417
1 parent 0a36f73 commit a0c68ab

File tree

1 file changed

+1
-8
lines changed

1 file changed

+1
-8
lines changed

src/pydocstyle/checker.py

+1-8
Original file line numberDiff line numberDiff line change
@@ -907,17 +907,10 @@ def _find_sphinx_params(lines):
907907
except `self` or `cls` if it is a method.
908908
909909
Documentation for each arg should start at the same indentation
910-
level. For example, in this case x and y are distinguishable::
910+
level::
911911
912912
:param x: Lorem ipsum dolor sit amet
913913
:param y: Ut enim ad minim veniam
914-
915-
In the case below, we only recognize x as a documented parameter
916-
because the rest of the content is indented as if it belongs
917-
to the description for x::
918-
919-
:param x: Lorem ipsum dolor sit amet
920-
:param y: Ut enim ad minim veniam
921914
"""
922915
params = []
923916
for line in lines:

0 commit comments

Comments
 (0)