Add EmptyDocComment lint rule#634
Conversation
|
this will need to be rebased/merged due to the changes in #614 . Thanks for the contribution, I can review it once the conflicts are resolved and the CI is passing ✅ |
|
Hey, @Serial-ATA @a-frantz ,I have resolved the merge conflicts and have also applied the suggested changes, please review them and let me know if anything needs to be changed. |
claymcleod
left a comment
There was a problem hiding this comment.
A few suggestions — the main issue is false-positives on paragraph separators in doc blocks.
|
Hey @claymcleod @Serial-ATA I have done the changes , thank you reviewing it, tell me if something still needs to be changed , I would be happy to do so |
Serial-ATA
left a comment
There was a problem hiding this comment.
Just some notes for the docs
Co-authored-by: Alex <69764315+Serial-ATA@users.noreply.github.com>
|
Hey @Serial-ATA , thanks for the suggestions, I’ve applied them |
Serial-ATA
left a comment
There was a problem hiding this comment.
LGTM after the changes above
|
Thanks for the review @claymcleod . I was being extra careful and over-commented this method. I’ve removed the redundant inline comments and kept it consistent with the surrounding rules. |
Add EmptyDocComment lint rule to flag empty ## documentation comments (single or multiple) with no meaningful text.
Fixes #632
Before submitting this PR, please make sure:
For external contributors:
For all contributors:
nextbranch in the sprocket.bio repository (when appropriate).For PRs containing lint rule changes:
RULES.md.crates/wdl-lint/tests/lintsthat covers everypossible diagnostic emitted for the rule within the file where the rule
is implemented.