Skip to content

Add EmptyDocComment lint rule#634

Open
raman976 wants to merge 16 commits intostjude-rust-labs:mainfrom
raman976:lint-empty-doc-comments
Open

Add EmptyDocComment lint rule#634
raman976 wants to merge 16 commits intostjude-rust-labs:mainfrom
raman976:lint-empty-doc-comments

Conversation

@raman976
Copy link
Contributor

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:

  • You have read the contributing guide in its entirety.
  • You have not used AI on any parts of this pull request.

For all contributors:

  • You have added a few sentences describing the PR here.
  • You have added yourself or the appropriate individual as the assignee.
  • You have added at least one relevant code reviewer to the PR.
  • Your code builds clean without any errors or warnings.
  • You have added tests (when appropriate).
  • You have added an entry in the CHANGELOG (when appropriate).
  • You have updated the README or other documentation to account for these changes (when appropriate).
  • You have made a PR to the next branch in the sprocket.bio repository (when appropriate).

For PRs containing lint rule changes:

  • You have updated any and all effected entries within RULES.md.
  • You have added a test case in crates/wdl-lint/tests/lints that covers every
    possible diagnostic emitted for the rule within the file where the rule
    is implemented.

@raman976 raman976 requested a review from a team as a code owner February 14, 2026 20:13
@raman976 raman976 requested a review from a-frantz February 14, 2026 20:13
@github-actions github-actions bot added the S-awaiting-pass-CI PR is awaiting CI to pass. label Feb 14, 2026
@a-frantz
Copy link
Member

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 ✅

@raman976
Copy link
Contributor Author

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.

Copy link
Member

@claymcleod claymcleod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few suggestions — the main issue is false-positives on paragraph separators in doc blocks.

@github-actions github-actions bot removed the S-awaiting-pass-CI PR is awaiting CI to pass. label Mar 7, 2026
@raman976
Copy link
Contributor Author

raman976 commented Mar 7, 2026

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

Copy link
Collaborator

@Serial-ATA Serial-ATA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some notes for the docs

raman976 and others added 2 commits March 10, 2026 16:17
Co-authored-by: Alex <69764315+Serial-ATA@users.noreply.github.com>
@github-actions github-actions bot added the S-awaiting-pass-CI PR is awaiting CI to pass. label Mar 10, 2026
@github-actions github-actions bot removed the S-awaiting-pass-CI PR is awaiting CI to pass. label Mar 10, 2026
@raman976
Copy link
Contributor Author

Hey @Serial-ATA , thanks for the suggestions, I’ve applied them

Copy link
Member

@claymcleod claymcleod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple small things:

Copy link
Collaborator

@Serial-ATA Serial-ATA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM after the changes above

@raman976
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Lint for empty doc comments

4 participants