DrString icon indicating copy to clipboard operation
DrString copied to clipboard

Published 20 hours ago • verified publisher icon dduan

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

Open dduan opened this issue 6 years ago • 1 comments

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 avatar Oct 16 '19 02:10 dduan

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.

dduan avatar Jan 27 '20 20:01 dduan