Fix Broken Docs References #5436
Conversation
|
arr00
requested review from
ernestognw and
Amxx
and removed request for
ernestognw
| @@ -159,7 +159,7 @@ abstract contract ERC721Consecutive is IERC2309, ERC721 { | |||
| } | |||
|
|
|||
| /** | |||
| * @dev Used to offset the first token id in {_nextConsecutiveId} | |||
| * @dev Used to offset the first token id in `_nextConsecutiveId` | |||
There was a problem hiding this comment.
Note: the rational here is that _nextConsecutiveId is a private function, and therefore doesn't appear in the docs
There was a problem hiding this comment.
Yeah this is important. I've personally like everything documented regardless of whether the function is private but is true that references to these functions are broken
| @@ -159,7 +159,7 @@ abstract contract ERC721Consecutive is IERC2309, ERC721 { | |||
| } | |||
|
|
|||
| /** | |||
| * @dev Used to offset the first token id in {_nextConsecutiveId} | |||
| * @dev Used to offset the first token id in `_nextConsecutiveId` | |||
There was a problem hiding this comment.
Yeah this is important. I've personally like everything documented regardless of whether the function is private but is true that references to these functions are broken
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
|
No changes in this PR apply to code merged since v5.2.0. It can be cherry-picked onto the docs branch easily. |
This PR fixes broken references in the generated docs.
PR Checklist
npx changeset add)