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

Fix false positive of google convention missing args descriptions #619

Merged

Conversation

stinovlas
Copy link
Contributor

@stinovlas stinovlas commented Jan 3, 2023

Closes #618.

  • Add unit tests and integration tests where applicable.
  • 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.

I'm not really happy about this heuristic, but it seems to do the work. It would be cleaner change the splitting of docstring to sections, but I'm afraid its not possible in general case due to numpy style having no indent. Anyway, this should fix the problem with google style convention and additional lines being considered part of the section.

The solution may not work in mixed tabs/spaces docstring where each line has different whitespace prefix, but I find this to be pretty obscure case (and it's obviously not covered by pydocstyle tests anyway).

@stinovlas stinovlas force-pushed the 618-fix-google-missing-args-descriptions branch from e9826bb to bfd113d Compare January 3, 2023 14:33
@sambhav sambhav merged commit 0107fe6 into PyCQA:master Jan 3, 2023
@stinovlas stinovlas deleted the 618-fix-google-missing-args-descriptions branch January 4, 2023 08:18
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

False positive of D417 (missing argument descriptions)
2 participants