Validate that '@param' comments on enumerators match a real field of that enumerator. - #822
Open
InsertCreativityHere wants to merge 2 commits into
Open
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
The implementation is correct and well-tested; only a minor test-name typo remains.
Pull request overview
Adds validation ensuring enumerator @param tags reference actual fields.
Changes:
- Validates enumerator parameter documentation.
- Adds valid and invalid comment tests.
File summaries
| File | Description |
|---|---|
slicec/src/validators/enums.rs |
Implements enumerator tag validation. |
slicec/tests/comment_tests.rs |
Covers accepted and rejected tags. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Currently
slicecdoesn't validate that@paramtags on enumerators are for real fields. For example, this produces no lints:This PR directly fixes #820, and is also the last piece of validation we were missing to consider #684 fully implemented.
What's Changed:
slicecnow validates that@paramtags on enumerators reference an existent field of the enumerator, like it already did for operation parameters.