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

When parameter docs are out of order, the report is confusing #74

Open
dduan opened this issue Oct 16, 2019 · 1 comment
Open

When parameter docs are out of order, the report is confusing #74

dduan opened this issue Oct 16, 2019 · 1 comment
Labels
enhancement New feature or request

Comments

@dduan
Copy link
Owner

dduan commented Oct 16, 2019

Right now you'll get a problem for a missing doc, and a problem for a redundant doc. There might be a good algorithm out there that could infer this better.
@dduan dduan added the enhancement New feature or request label Oct 16, 2019
@dduan
Copy link
Owner Author

dduan commented Jan 27, 2020

Current algorithm:

  1. find longest common sequence (lcs) between parameters in signature and existing entries in docstring
  2. report parameters that are in signature but not lcs as missing
  3. report parameters found in docstring but not lcs as redundant.

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
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dduan