pydocstyle icon indicating copy to clipboard operation
pydocstyle copied to clipboard
verified publisher icon PyCQA

add support for sphinx-style parameters to D417

Open benji-york opened this issue 3 years ago • 1 comments

Hi!

Numpy and Google-style parameter documentation is great, but some people use Sphinx-style parameter docs. This PR adds support for those to the D417 checker.

This is my first contribution to pydocstyle, so I'm unsure about the testing style. In particular, the tests I added in src/tests/test_sphinx.py seem to be a little out of character for the code base. However, they seem like good tests to me, so I would especially appreciate feedback on those.

--

Thanks for submitting a PR!

Please make sure to check for the following items:

  • [x] Add unit tests and integration tests where applicable.
    If you've added an error code or changed an error code behavior, you should probably add or change a test case file under tests/test_cases/ and add it to the list under tests/test_definitions.py.
    If you've added or changed a command line option, you should probably add or change a test in tests/test_integration.py.
  • [x] Add a line to the release notes (docs/release_notes.rst) under "Current Development Version".
    Make sure to include the PR number after you open and get one.

Please don't get discouraged as it may take a while to get a review.

benji-york avatar Jun 17 '22 12:06 benji-york

Can I get a maintainer to approve the workflow to run the CI checks?

Thanks!

benji-york avatar Jul 13 '22 15:07 benji-york

Anything holding this up? Seems to have been open for a while. Would be great to get this feature in.

rrwalton avatar Feb 10 '23 21:02 rrwalton

Anything holding this up? Seems to have been open for a while. Would be great to get this feature in.

Not meant to be a criticism in any way. Not sure why I got a thumbs down for this comment. I'd just find this feature useful, that's all.

rrwalton avatar Feb 11 '23 22:02 rrwalton

@benji-york, LGTM, but I can't approve or merge anymore despite https://github.com/PyCQA/pydocstyle/issues/575. Please be patient @samj1912 will get to it at some point :)

Pierre-Sassoulas avatar Feb 11 '23 22:02 Pierre-Sassoulas

Meta comment: I'm not sure what constraints this project is running under, but the combination of required CI jobs for PR progress, required admin approval for CI jobs, and slow admin approval make for a painful contribution process—as exemplified by the timeline of this PR.

benji-york avatar Sep 22 '23 13:09 benji-york

This PR added the change to the changelog section about 6.2.0, which was released ten months before merging this PR.

JulianJvn avatar Oct 06 '23 09:10 JulianJvn