Use return instead of param for return parameter documentation#241
Merged
PaulRBerg merged 1 commit intoPaulRBerg:mainfrom Jul 22, 2024
Merged
Use return instead of param for return parameter documentation#241PaulRBerg merged 1 commit intoPaulRBerg:mainfrom
PaulRBerg merged 1 commit intoPaulRBerg:mainfrom
Conversation
Owner
|
Good catch! Thanks for the PR. Do you need a new version shipped to the npm registry or can you install from GitHub directly? |
Contributor
Author
|
Thanks @PaulRBerg. I don't need a new version, this is just a suggested improvement for the NatSpec tags. |
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
2 participants
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.
Some functions document the return parameter using the
@paramNatSpec tag, and the Solidity compiler does not fail in these cases. However, since these are referring to return parameters instead of function parameters, it would be more correct to document them as@returninstead.