NatSpec: Restrict @param validation to input parameters.#16667
Open
cuiweixie wants to merge 1 commit intoargotorg:developfrom
Open
NatSpec: Restrict @param validation to input parameters.#16667cuiweixie wants to merge 1 commit intoargotorg:developfrom
cuiweixie wants to merge 1 commit intoargotorg:developfrom
Conversation
Named return bindings are surfaced through @return documentation, whereas @param historically also accepted those identifiers and blurred the distinction. By mirroring downstream NatSpec tooling expectations, exclude return parameter names when checking DocString @param tags so only inbound arguments count as documented parameters rather than permitting duplicate coverage paths.
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
1 participant
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.
Description
Named return bindings are surfaced through @return documentation, whereas @param historically also accepted those identifiers and blurred the distinction. By mirroring downstream NatSpec tooling expectations, exclude return parameter names when checking DocString @param tags so only inbound arguments count as documented parameters rather than permitting duplicate coverage paths.
Checklist
AI Disclosure