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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #618.
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 withgoogle
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).