Fix Broken Docs References #5436

arr00 · 2025-01-16T22:51:49Z

This PR fixes broken references in the generated docs.

PR Checklist

Tests
Documentation
Changeset entry (run npx changeset add)

changeset-bot · 2025-01-16T22:51:53Z

⚠️ No Changeset found

Latest commit: 4d6d35e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Amxx · 2025-01-22T16:02:18Z

contracts/token/ERC721/extensions/ERC721Consecutive.sol

@@ -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`


Note: the rational here is that _nextConsecutiveId is a private function, and therefore doesn't appear in the docs

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

.gitignore

contracts/proxy/utils/UUPSUpgradeable.sol

ernestognw · 2025-01-22T17:44:05Z

contracts/token/ERC721/extensions/ERC721Consecutive.sol

@@ -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`


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

docs/templates/properties.js

arr00 · 2025-01-22T22:06:06Z

No changes in this PR apply to code merged since v5.2.0. It can be cherry-picked onto the docs branch easily.

* Update ReentrancyGuardTransient documentation (OpenZeppelin#5417) * Optimize `MerkleTree` for loops by using `uint256` iterators (OpenZeppelin#5415) Co-authored-by: Ernesto García <ernestognw@gmail.com> * Update `_revokeRole` documentation in AccessControl (OpenZeppelin#5321) Co-authored-by: Ernesto García <ernestognw@gmail.com> * Merge release-v5.2 branch (OpenZeppelin#5424) Signed-off-by: Hadrien Croubois <hadrien.croubois@gmail.com> Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> Co-authored-by: Sam Bugs <101145325+0xsambugs@users.noreply.github.com> Co-authored-by: Ernesto García <ernestognw@gmail.com> Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com> Co-authored-by: wizard <112275929+famouswizard@users.noreply.github.com> Co-authored-by: leopardracer <136604165+leopardracer@users.noreply.github.com> Co-authored-by: cairo <cairoeth@protonmail.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Francisco Giordano <fg@frang.io> Co-authored-by: Simka <0xsimka@gmail.com> Co-authored-by: Voronor <129545215+voronor@users.noreply.github.com> * Add a Calldata library with `emptyBytes` and `emptyString` functions (OpenZeppelin#5422) Co-authored-by: Ernesto García <ernestognw@gmail.com> * Update governor docs (OpenZeppelin#5420) * Add missing `Calldata`, `Bytes`, `CAIP2` and `CAIP10` API references (OpenZeppelin#5428) * Expose `_isTrustedByTarget` internally in ERC2771Forwarder (OpenZeppelin#5416) * Update LICENSE (OpenZeppelin#5434) * Refactor EnumerableSet.behavior.js for reuse in the community repo (OpenZeppelin#5441) * Replace `overriden` with `overridden` in GovernorCountingOverridable.sol (OpenZeppelin#5446) Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com> Co-authored-by: ernestognw <ernestognw@gmail.com> * Remove Unnecessary Initialisation of `_paused` (OpenZeppelin#5448) Co-authored-by: Ernesto García <ernestognw@gmail.com> * Fix Broken Docs References (OpenZeppelin#5436) * Update actions/upload-artifact action to v4 (OpenZeppelin#4826) * Remove unused `setBaseURI` tests (OpenZeppelin#5456) Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> * Group typographical errors (OpenZeppelin#5443) Co-authored-by: futreall <86553580+futreall@users.noreply.github.com> Co-authored-by: Marco <wudmytrotest200@gmail.com> Co-authored-by: Dmitry <98899785+mdqst@users.noreply.github.com> Co-authored-by: Dmytrol <46675332+Dimitrolito@users.noreply.github.com> Co-authored-by: Noisy <125606576+donatik27@users.noreply.github.com> Co-authored-by: Danil <37103154+Danyylka@users.noreply.github.com> Co-authored-by: CrazyFrog <anna.shuraeva13@gmail.com> Co-authored-by: Bryer <0xbryer@gmail.com> Co-authored-by: Viktor Pavlik <160131789+Vikt0rPavlik@users.noreply.github.com> Co-authored-by: Skylar Ray <137945430+sky-coderay@users.noreply.github.com> Co-authored-by: Brawn <nftdropped@gmail.com> Co-authored-by: fuder.eth <139509124+vtjl10@users.noreply.github.com> Co-authored-by: FT <140458077+zeevick10@users.noreply.github.com> Co-authored-by: Ann Wagner <chant_77_swirly@icloud.com> Co-authored-by: Hopium <135053852+Hopium21@users.noreply.github.com> Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com> Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> * Fix interface docs ordering and add missing interface (OpenZeppelin#5460) * Add a governor extension that implements a proposal guardian (OpenZeppelin#5303) Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com> Co-authored-by: Ernesto García <ernestognw@gmail.com> * Fix the CLI output of formal verification runs (OpenZeppelin#5445) * Update dependency halmos to v0.2.4 (OpenZeppelin#5461) Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> * Use stable foundry version in CI (OpenZeppelin#5465) * Add stake management function to ERC4337Utils (OpenZeppelin#5471) * Add forum badge correct link (OpenZeppelin#5481) * SafeERC20.trySafeTransfer{,from} (OpenZeppelin#5483) * Improve promise rejections handling in hardhat/async-test-sanity.js (OpenZeppelin#5429) Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com> * Use slither v0.10.4 (OpenZeppelin#5488) * Add ERC6909 Implementation along with extensions (OpenZeppelin#5394) Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> Co-authored-by: Ernesto García <ernestognw@gmail.com> * Rename ERC4337Utils ENTRYPOINT to ENTRYPOINT_V07 (OpenZeppelin#5472) Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> * Add Bytes32x2Set (OpenZeppelin#5442) Co-authored-by: Ernesto García <ernestognw@gmail.com> * Add clear function to Enumerable{Set,Map} (OpenZeppelin#5486) Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> * Make set-max-old-space-size.sh compatible with sh (OpenZeppelin#5493) Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> * Update FUNDING.json (OpenZeppelin#5496) Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> * Update FUNDING.json hierarchy (OpenZeppelin#5500) Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> * Test behavior of SignatureChecker against the identity precompile (0x4) (OpenZeppelin#5501) * Treat code-size warnings as errors (OpenZeppelin#5101) Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> * Make `TimelockController` receive function virtual (OpenZeppelin#5506) Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com> Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> --------- Signed-off-by: Hadrien Croubois <hadrien.croubois@gmail.com> Co-authored-by: Ernesto García <ernestognw@gmail.com> Co-authored-by: Michael <20623991+heueristik@users.noreply.github.com> Co-authored-by: Maks <soskapola96@gmail.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> Co-authored-by: Sam Bugs <101145325+0xsambugs@users.noreply.github.com> Co-authored-by: Arr00 <13561405+arr00@users.noreply.github.com> Co-authored-by: wizard <112275929+famouswizard@users.noreply.github.com> Co-authored-by: leopardracer <136604165+leopardracer@users.noreply.github.com> Co-authored-by: cairo <cairoeth@protonmail.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Francisco Giordano <fg@frang.io> Co-authored-by: Simka <0xsimka@gmail.com> Co-authored-by: Voronor <129545215+voronor@users.noreply.github.com> Co-authored-by: Eric Lau <ericglau@outlook.com> Co-authored-by: planetBoy <140164174+Guayaba221@users.noreply.github.com> Co-authored-by: sudo rm -rf --no-preserve-root / <pcaversaccio@users.noreply.github.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> Co-authored-by: Renan Souza <renan.rodrigues.souza1@gmail.com> Co-authored-by: futreall <86553580+futreall@users.noreply.github.com> Co-authored-by: Marco <wudmytrotest200@gmail.com> Co-authored-by: Dmitry <98899785+mdqst@users.noreply.github.com> Co-authored-by: Dmytrol <46675332+Dimitrolito@users.noreply.github.com> Co-authored-by: Noisy <125606576+donatik27@users.noreply.github.com> Co-authored-by: Danil <37103154+Danyylka@users.noreply.github.com> Co-authored-by: CrazyFrog <anna.shuraeva13@gmail.com> Co-authored-by: Bryer <0xbryer@gmail.com> Co-authored-by: Viktor Pavlik <160131789+Vikt0rPavlik@users.noreply.github.com> Co-authored-by: Skylar Ray <137945430+sky-coderay@users.noreply.github.com> Co-authored-by: Brawn <nftdropped@gmail.com> Co-authored-by: fuder.eth <139509124+vtjl10@users.noreply.github.com> Co-authored-by: FT <140458077+zeevick10@users.noreply.github.com> Co-authored-by: Ann Wagner <chant_77_swirly@icloud.com> Co-authored-by: Hopium <135053852+Hopium21@users.noreply.github.com> Co-authored-by: Yan Victor SN <98413246+YanVictorSN@users.noreply.github.com> Co-authored-by: Ursula <asp_woods_34@icloud.com> Co-authored-by: Michalis Kargakis <kargakis@protonmail.com> Co-authored-by: luca <80516439+xdaluca@users.noreply.github.com> Co-authored-by: Jonas <43515441+JSeiferth@users.noreply.github.com> Co-authored-by: Joseph Delong <joseph@delong.me>

Fix Broken Docs References

100eb8b

arr00 added the ignore-changeset label Jan 17, 2025

arr00 added 2 commits January 16, 2025 15:10

fix more references

16b6380

fix references in string lib

8f95c0b

arr00 changed the title ~~WIP: Fix Broken Docs References~~ Fix Broken Docs References Jan 17, 2025

arr00 added 2 commits January 16, 2025 19:32

update docs

08553ff

remove reference to deleted section

6aeea70

arr00 requested review from ernestognw and Amxx and removed request for ernestognw January 17, 2025 06:21

arr00 added 2 commits January 17, 2025 15:33

remove escape

a08e578

fix broken reference GovernorCountingOverridable

4d6d35e

Amxx added the documentation Inline comments, guides, and examples. label Jan 22, 2025

Amxx reviewed Jan 22, 2025

View reviewed changes

ernestognw reviewed Jan 22, 2025

View reviewed changes

ernestognw approved these changes Jan 22, 2025

View reviewed changes

This comment was marked as resolved.

Sign in to view

arr00 requested a review from Amxx January 23, 2025 17:24

Amxx approved these changes Jan 24, 2025

View reviewed changes

Amxx merged commit 6dc9242 into OpenZeppelin:master Jan 24, 2025
21 checks passed

arr00 deleted the chore/fix-broken-docs branch January 24, 2025 14:19

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Broken Docs References #5436

Fix Broken Docs References #5436

arr00 commented Jan 16, 2025 •

edited

Loading

changeset-bot bot commented Jan 16, 2025 •

edited

Loading

Amxx Jan 22, 2025

ernestognw Jan 22, 2025

ernestognw Jan 22, 2025

This comment was marked as resolved.

arr00 commented Jan 22, 2025

Fix Broken Docs References #5436

Fix Broken Docs References #5436

Conversation

arr00 commented Jan 16, 2025 • edited Loading

PR Checklist

changeset-bot bot commented Jan 16, 2025 • edited Loading

⚠️ No Changeset found

Amxx Jan 22, 2025

Choose a reason for hiding this comment

ernestognw Jan 22, 2025

Choose a reason for hiding this comment

ernestognw Jan 22, 2025

Choose a reason for hiding this comment

This comment was marked as resolved.

arr00 commented Jan 22, 2025

arr00 commented Jan 16, 2025 •

edited

Loading

changeset-bot bot commented Jan 16, 2025 •

edited

Loading