Fix spurious @notice error for untagged docs on file-level variables #16365
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.
Fixes #16355
Untagged documentation comments on file-level variables (like
/** whatever... */above a constant) were being implicitly converted to@notice, which then failed validation since@noticeis not valid for file-level variables. Users would get an error for a tag they never explicitly used.This fix passes the set of valid tags to the DocString parser so it can check whether
@noticeis valid before adding it implicitly. When it's not valid, the parser skips the untagged text and continues processing so any explicit valid tags like@devstill work.Changes: