Fix: Corrected @param typos in NatSpec comments#256
Open
rickymcalister wants to merge 1 commit intoimmutable:mainfrom
Open
Fix: Corrected @param typos in NatSpec comments#256rickymcalister wants to merge 1 commit intoimmutable:mainfrom
rickymcalister wants to merge 1 commit intoimmutable:mainfrom
Conversation
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.
This is a small fix to remove white space preceding a couple of
@paramtags in theMintingAccessControl.solabstract contract.NatSpec documentation tools (like those used to generate documentation websites from Solidity code) rely on correctly formatted tags like
@param,@return,@notice, etc. The non-breaking space may prevent these tools from correctly parsing the comment, which means the parameter documentation might not be displayed correctly in generated documentation.