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.

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

Code has changed (significantly), but the DocBlock has not #44

Open
NielsdeBlaauw opened this issue Feb 4, 2019 · 0 comments
Open

Code has changed (significantly), but the DocBlock has not #44

NielsdeBlaauw opened this issue Feb 4, 2019 · 0 comments
Labels

Comments

@NielsdeBlaauw
Copy link
Owner

If we can make some kind of snapshot of the docblocks for a function/method at a certain time, we can see which documentation has not been updated when the function is changed.

This would include the following steps:

  1. Edit function with a docblock.
  2. Run php-doc-check
  3. If the functions meet a complexity metric: php-doc-check will compare the current docblock and function (length or complexity) to what is saved in the snapshot.
    3.a. If the DocBlock is the same as the one in the snapshot: error that the DocBlock has not been updated.
    3.b. If the DocBlock has changed, update the snapshot with the new docblock and filelength.
  4. Manually edit the DocBlocks that have errored where applicable
  5. Goto step 3 until all errors have been removed, or all the docblocks for all remaining errors are still descriptive of the function and origin of the code.
  6. If remaining errors don't require changes: manually regenerate snapshot.
  7. Commit changes and snapshot.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant