Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Parameter label mistakenly used as parameter name is not detected #172

Open
dduan opened this issue Feb 8, 2020 · 0 comments
Open

Parameter label mistakenly used as parameter name is not detected #172

dduan opened this issue Feb 8, 2020 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@dduan
Copy link
Owner

dduan commented Feb 8, 2020

A common-ish mistake for docstring author is to use the label of a parameter as opposed to the actual name. The error message in this scenario could be improved. Right now the parameter docstring is reported as missing. It could be something like "Parameter label (X) is used instead of name (Y)".
@dduan dduan added enhancement New feature or request good first issue Good for newcomers labels Feb 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dduan