chore: fix cargo doc errors #4510

ehegnes · 2025-05-03T06:25:38Z

No description provided.

Signed-off-by: Eric Hegnes <eric@hegnes.com>

vercel · 2025-05-03T06:25:42Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
site	⬜️ Ignored (Inspect)			May 3, 2025 6:25am

benluelo · 2025-05-03T15:31:51Z

cosmwasm/ibc-union/app/ucs03-zkgm/src/contract.rs

@@ -49,7 +49,7 @@ pub const ZKGM_TOKEN_MINTER_LABEL: &str = "zkgm-token-minter";

 /// 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.


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.

benluelo · 2025-05-03T15:32:12Z

cosmwasm/ibc-union/core/msg/src/lightclient.rs

@@ -64,7 +64,7 @@ pub enum QueryMsg {
    GetStatus {
        client_id: ClientId,
    },
-    /// NOTE: Reads state through the [`QueryStore`].
+    /// NOTE: Reads state through the `ibc_union::state::QueryStore`.


Suggested change

/// NOTE: Reads state through the `ibc_union::state::QueryStore`.

/// NOTE: Reads state through the `QueryStore`.

benluelo · 2025-05-03T15:32:19Z

cosmwasm/ibc-union/core/msg/src/lightclient.rs

@@ -83,13 +83,13 @@ pub enum QueryMsg {
        proof: Bytes,
        path: Bytes,
    },
-    /// NOTE: Reads state through the [`QueryStore`].
+    /// NOTE: Reads state through the `ibc_union::state::QueryStore`.


Suggested change

/// NOTE: Reads state through the `ibc_union::state::QueryStore`.

/// NOTE: Reads state through the `QueryStore`.

benluelo · 2025-05-03T15:32:25Z

cosmwasm/ibc-union/core/msg/src/lightclient.rs

    UpdateState {
        caller: String,
        client_id: ClientId,
        relayer: String,
    },
-    /// TODO: Should read state through the [`QueryStore`].
+    /// TODO: Should read state through the `ibc_union::state::QueryStore`.


Suggested change

/// TODO: Should read state through the `ibc_union::state::QueryStore`.

/// TODO: Should read state through the `QueryStore`.

benluelo · 2025-05-03T15:35:57Z

lib/arbitrum-types/src/lib.rs

@@ -17,50 +17,40 @@ pub mod slots {
    use solidity_slot::{MappingKey, Slot, U256};
    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).


why? just fix the link instead:

/// [`_latestNodeCreated`]: https://github.com/OffchainLabs/nitro-contracts/blob/90037b996509312ef1addb3f9352457b8a99d6a6/src/rollup/RollupCore.sol#L62 ^ here

benluelo · 2025-05-03T15:42:09Z

lib/voyager-message/src/call.rs

+/// [`crate::Callback::AggregateSubmitTxFromOrderedHeaders`] message, which will
+/// be used to build the actual [`unionlabs::ibc::core::client::msg_update_client::MsgUpdateClient`]s.


same comment here

benluelo · 2025-05-03T15:42:40Z

lib/arbitrum-types/src/lib.rs

-    /// 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.


this should link to rollup_core_nodes_confirm_data_slot

benluelo · 2025-05-03T15:43:24Z

voyager/plugins/transaction-batch/src/callback.rs

-/// 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.


keep the links but include the full path to types not already in scope

benluelo · 2025-05-03T15:44:35Z

voyager/plugins/transaction-batch/src/data.rs

@@ -37,7 +37,7 @@ pub struct BatchableEvent<V: IbcSpecExt> {
 }

 // 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.


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.

benluelo · 2025-05-03T15:44:47Z

voyager/plugins/transaction-batch/src/data.rs

@@ -74,7 +74,7 @@ impl TryFrom<ibc_classic_spec::FullEvent> for EventClassic {
 }

 // 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.


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.

chore: fix cargo doc errors

397e61e

Signed-off-by: Eric Hegnes <eric@hegnes.com>

ehegnes requested a review from benluelo as a code owner May 3, 2025 06:25

benluelo requested changes May 3, 2025

View reviewed changes

unionlabs deleted a comment May 3, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

chore: fix cargo doc errors #4510

chore: fix cargo doc errors #4510

Uh oh!

ehegnes commented May 3, 2025

Uh oh!

vercel bot commented May 3, 2025

Uh oh!

benluelo May 3, 2025

Uh oh!

benluelo May 3, 2025

Uh oh!

benluelo May 3, 2025

Uh oh!

benluelo May 3, 2025

Uh oh!

benluelo May 3, 2025

Uh oh!

benluelo May 3, 2025

Uh oh!

benluelo May 3, 2025

Uh oh!

benluelo May 3, 2025

Uh oh!

benluelo May 3, 2025

Uh oh!

benluelo May 3, 2025

Uh oh!

Uh oh!

	/// 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.

	/// NOTE: Reads state through the `ibc_union::state::QueryStore`.
	/// NOTE: Reads state through the `QueryStore`.

	/// TODO: Should read state through the `ibc_union::state::QueryStore`.
	/// TODO: Should read state through the `QueryStore`.

		/// [`crate::Callback::AggregateSubmitTxFromOrderedHeaders`] message, which will
		/// be used to build the actual [`unionlabs::ibc::core::client::msg_update_client::MsgUpdateClient`]s.

		/// 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.

	/// 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.

	/// 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.

chore: fix cargo doc errors #4510

Are you sure you want to change the base?

chore: fix cargo doc errors #4510

Uh oh!

Conversation

ehegnes commented May 3, 2025

Uh oh!

vercel bot commented May 3, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!