Improving comments for the _burn() function in ERC721URIStorage. #3324
Conversation
This file contains 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
Currently the comments for this function are really documenting what the inherited function does in the parent contract (in other words, they are describing what happens when 'super' is called). This commit changes the comments to be more in line with other comments of other inherited functions, whereby reference is made to the parent contract, but the comments describe the local version of the function. An example of this can be seen in ERC721Royalty.sol, where the comments reference the parent contract, but describe the functionality of what the override is doing. This seems like a better approach, because if the parent contract were to every be changed, the comments would not necessarily need amending in the descendants.
frangio
approved these changes
Apr 7, 2022
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.
Currently the comments for this function are really documenting what the
inherited function does in the parent contract (in other words, they are
describing what happens when 'super' is called). This commit changes the
comments to be more in line with other comments of other inherited
functions, whereby reference is made to the parent contract, but the
comments describe the local version of the function. An example of this
can be seen in ERC721Royalty.sol, where the comments reference the
parent contract, but describe the functionality of what the override is
doing. This seems like a better approach, because if the parent contract
were to every be changed, the comments would not necessarily need
amending in the descendants.
Fixes #3324
PR Checklist