Skip to content
This repository has been archived by the owner on Dec 16, 2022. It is now read-only.

Typo in docstring section name leads to confusing DAR101 errors #171

Open
taranlu-houzz opened this issue Jun 24, 2021 · 1 comment
Open

Comments

@taranlu-houzz
Copy link

Not sure if this is actually something that should be addressed by darglint, but I just ran into a very confusing issue where I had a typo in for the name of the "Parameters" section of my docstring (numpy docstring format). This made it so that darglint reported missing parameters (DAR101), which was very confusing, since my typo was not obvious ("Paramaters"), and the error made me focus on the parameter names themselves. I was wondering if maybe it would make sense to have darglint check for missing section headings to help clarify such scenarios?

@taranlu-houzz
Copy link
Author

I also had a case where I was missing an "s" for the "Warnings" heading, which comes after "Parameters," "Returns," etc. This made darglint report that all params where missing, which was extremely confusing.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant