Fix broken VerificationEthAddressClaim doc links in signer docs #2584
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.
Why is this change needed?
This PR updates the documentation links for VerificationEthAddressClaim in the signer docs (ViemLocalEip712Signer.md, EthersV5Eip712Signer.md, and EthersEip712Signer.md). The links now correctly point to the VerificationEthAddressClaim section in Messages.md instead of the outdated or missing types.md. This ensures that users can easily find the relevant type documentation without encountering broken links.
Choose all relevant options below by adding an
xnow or at any time before submitting for reviewPR-Codex overview
This PR updates the documentation for the
claimparameter in three signer files, changing the reference from../modules/types.md#verificationethaddressclaimto../Messages.md#verificationethaddressclaim.Detailed summary
claimreference inEthersEip712Signer.mdto point to../Messages.md#verificationethaddressclaim.claimreference inEthersV5Eip712Signer.mdto point to../Messages.md#verificationethaddressclaim.claimreference inViemLocalEip712Signer.mdto point to../Messages.md#verificationethaddressclaim.