fix(contracts): fails gracefully when building contracts docs + removing unwanted docstring #15494
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ |
clemsos
commented
Feb 5, 2025
| @@ -2842,7 +2842,7 @@ interface IUnlock { | |||
| * @notice This function can be called by anyone (not only the contract owner) as a way to ensure decentralization. | |||
| * @param token the address of the token (zero address for native) to swap and burn | |||
| * @param amount the amount of tokens to swap and burn | |||
| * @param poolFee the poolFee of the token <> WETH/Wrapped Native asset to use for the swap | |||
There was a problem hiding this comment.
the <> characters were interpreted as a html tag by the docgen, so had to replace it
clemsos
commented
Feb 5, 2025
| @@ -258,7 +258,6 @@ interface IPublicLock { | |||
| * @param referrer the referrer that will be granted the governance tokens | |||
| * @param keyManager the manager of the key (can cancel, transfer, burn the key) | |||
| * @param data additional data to be used by jooks or other 3rd part contracts | |||
| * @return tokenIds the ids of the created tokens | |||
There was a problem hiding this comment.
a struct actually returns nothing, leading the docgen to exit 1
clemsos
commented
Feb 5, 2025
| @@ -42,7 +42,7 @@ library MerkleProof { | |||
| } | |||
|
|
|||
| /** | |||
| * @dev Calldata version of {verify} | |||
There was a problem hiding this comment.
remove brackets as docusaurus will consider that an mdx template tag
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.
Description
This makes sure the script to build contracts docs fails correctly. Also it removes an unwanted docstring that prevents docs from building (see #15493)
Issues
Fixes #
Refs #
Checklist:
Release Note Draft Snippet