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

Commit

Permalink
tweak internal documentation for Sphinx-style D417
Browse files Browse the repository at this point in the history
  • Loading branch information
benji-york committed Sep 22, 2023
1 parent 0462dce commit 1e7dda2
Showing 1 changed file with 1 addition and 8 deletions.
9 changes: 1 addition & 8 deletions src/pydocstyle/checker.py
Original file line number Diff line number Diff line change
Expand Up @@ -928,17 +928,10 @@ def _find_sphinx_params(lines):
except `self` or `cls` if it is a method.
Documentation for each arg should start at the same indentation
level. For example, in this case x and y are distinguishable::
level::
:param x: Lorem ipsum dolor sit amet
:param y: Ut enim ad minim veniam
In the case below, we only recognize x as a documented parameter
because the rest of the content is indented as if it belongs
to the description for x::
:param x: Lorem ipsum dolor sit amet
:param y: Ut enim ad minim veniam
"""
params = []
for line in lines:
Expand Down

0 comments on commit 1e7dda2

Please sign in to comment.