chore: fix cargo doc errors #4510
Open
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
Signed-off-by: Eric Hegnes <[email protected]>
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
benluelo
requested changes
May 3, 2025
| /// Instantiate `ucs03-zkgm`. | ||
| /// | ||
| /// This will instantiate the minter contract with the provided [`TokenMinterInitMsg`][crate::msg::TokenMinterInitMsg]. The admin of the minter contract is set to `ucs03-zkgm`. All migrations for the minter will be threaded through the `ucs03-zkgm` migrate entrypoint. | ||
| /// This will instantiate the minter contract with the provided [`ucs03_zkgm_token_minter_api::TokenMinterInitMsg`]. The admin of the minter contract is set to `ucs03-zkgm`. All migrations for the minter will be threaded through the `ucs03-zkgm` migrate entrypoint. |
There was a problem hiding this comment.
Suggested change
| /// This will instantiate the minter contract with the provided [`ucs03_zkgm_token_minter_api::TokenMinterInitMsg`]. The admin of the minter contract is set to `ucs03-zkgm`. All migrations for the minter will be threaded through the `ucs03-zkgm` migrate entrypoint. | |
| /// This will instantiate the minter contract with the provided [`TokenMinterInitMsg`][ucs03_zkgm_token_minter_api::TokenMinterInitMsg]. The admin of the minter contract is set to `ucs03-zkgm`. All migrations for the minter will be threaded through the `ucs03-zkgm` migrate entrypoint. |
| client_id: ClientId, | ||
| }, | ||
| /// NOTE: Reads state through the [`QueryStore`]. | ||
| /// NOTE: Reads state through the `ibc_union::state::QueryStore`. |
There was a problem hiding this comment.
Suggested change
| /// NOTE: Reads state through the `ibc_union::state::QueryStore`. | |
| /// NOTE: Reads state through the `QueryStore`. |
| path: Bytes, | ||
| }, | ||
| /// NOTE: Reads state through the [`QueryStore`]. | ||
| /// NOTE: Reads state through the `ibc_union::state::QueryStore`. |
There was a problem hiding this comment.
Suggested change
| /// NOTE: Reads state through the `ibc_union::state::QueryStore`. | |
| /// NOTE: Reads state through the `QueryStore`. |
| relayer: String, | ||
| }, | ||
| /// TODO: Should read state through the [`QueryStore`]. | ||
| /// TODO: Should read state through the `ibc_union::state::QueryStore`. |
There was a problem hiding this comment.
Suggested change
| /// TODO: Should read state through the `ibc_union::state::QueryStore`. | |
| /// TODO: Should read state through the `QueryStore`. |
| use unionlabs_primitives::ByteArrayExt; | ||
|
|
||
| /// The slot containing [`_latestNodeCreated`]. | ||
| /// The slot containing [`_latestNodeCreated`](https://github.com/OffchainLabs/nitro-contracts/blob/90037b996509312ef1addb3f9352457b8a99d6a6/src/rollup/RollupCore.sol#L62). |
There was a problem hiding this comment.
why? just fix the link instead:
/// [`_latestNodeCreated`]: https://github.com/OffchainLabs/nitro-contracts/blob/90037b996509312ef1addb3f9352457b8a99d6a6/src/rollup/RollupCore.sol#L62
^ here
Comment on lines
+92
to
+93
| /// [`crate::Callback::AggregateSubmitTxFromOrderedHeaders`] message, which will | ||
| /// be used to build the actual [`unionlabs::ibc::core::client::msg_update_client::MsgUpdateClient`]s. |
| /// Use [`nodes()`] to calculate the slot for the mapping. | ||
| /// | ||
| /// [`_nodes`] https://github.com/OffchainLabs/nitro-contracts/blob/90037b996509312ef1addb3f9352457b8a99d6a6/src/rollup/RollupCore.sol#64 | ||
| /// Use `nodes()` to calculate the slot for the mapping. |
There was a problem hiding this comment.
this should link to rollup_core_nodes_confirm_data_slot
| } | ||
|
|
||
| /// Given an [`OrderedMsgUpdateClients`], returns [`Op`]s that generate [`IbcMessage`]s with proofs at the highest height of the updates. | ||
| /// Given an `OrderedMsgUpdateClients`, returns [`Op`]s that generate `IbcMessage`s with proofs at the highest height of the updates. |
There was a problem hiding this comment.
keep the links but include the full path to types not already in scope
|
|
||
| // REVIEW: We probably want to add a way to have "a packet timed out" be a variant here as well | ||
| /// A subset of [`FullEvent`], containing only events that cause an action on the counterparty chain. | ||
| /// A subset of [`ibc_classic_spec::FullEvent`], containing only events that cause an action on the counterparty chain. |
There was a problem hiding this comment.
Suggested change
| /// A subset of [`ibc_classic_spec::FullEvent`], containing only events that cause an action on the counterparty chain. | |
| /// A subset of [`FullEvent`][ibc_classic_spec::FullEvent], containing only events that cause an action on the counterparty chain. |
|
|
||
| // REVIEW: We probably want to add a way to have "a packet timed out" be a variant here as well | ||
| /// A subset of [`FullEvent`], containing only events that cause an action on the counterparty chain. | ||
| /// A subset of [`ibc_union_spec::event::FullEvent`], containing only events that cause an action on the counterparty chain. |
There was a problem hiding this comment.
Suggested change
| /// A subset of [`ibc_union_spec::event::FullEvent`], containing only events that cause an action on the counterparty chain. | |
| /// A subset of [`FullEvent`][ibc_union_spec::event::FullEvent], containing only events that cause an action on the counterparty chain. |
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.
No description provided.