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

Commit 1e7dda2

Browse files
committed
tweak internal documentation for Sphinx-style D417
1 parent 0462dce commit 1e7dda2

File tree

1 file changed

+1
-8
lines changed

1 file changed

+1
-8
lines changed

src/pydocstyle/checker.py

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -928,17 +928,10 @@ def _find_sphinx_params(lines):
928928
except `self` or `cls` if it is a method.
929929
930930
Documentation for each arg should start at the same indentation
931-
level. For example, in this case x and y are distinguishable::
931+
level::
932932
933933
:param x: Lorem ipsum dolor sit amet
934934
:param y: Ut enim ad minim veniam
935-
936-
In the case below, we only recognize x as a documented parameter
937-
because the rest of the content is indented as if it belongs
938-
to the description for x::
939-
940-
:param x: Lorem ipsum dolor sit amet
941-
:param y: Ut enim ad minim veniam
942935
"""
943936
params = []
944937
for line in lines:

0 commit comments

Comments
 (0)