Skip to content

Fix: Corrected @param typos in NatSpec comments#256

Open
rickymcalister wants to merge 1 commit intoimmutable:mainfrom
rickymcalister:ricky-fix-natspec-typo
Open

Fix: Corrected @param typos in NatSpec comments#256
rickymcalister wants to merge 1 commit intoimmutable:mainfrom
rickymcalister:ricky-fix-natspec-typo

Conversation

@rickymcalister
Copy link

This is a small fix to remove white space preceding a couple of @param tags in the MintingAccessControl.sol abstract 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant