Skip to content

Commit

Permalink
update docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
rnbguy committed Apr 30, 2024
1 parent 5900434 commit b8db190
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions ibc-testkit/src/testapp/ibc/core/core_ctx.rs
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ where
.collect::<Result<Vec<_>, _>>()
}

Check warning on line 392 in ibc-testkit/src/testapp/ibc/core/core_ctx.rs

View check run for this annotation

Codecov / codecov/patch

ibc-testkit/src/testapp/ibc/core/core_ctx.rs#L384-L392

Added lines #L384 - L392 were not covered by tests

/// Connections queries all the IBC connections of a chain.
/// Returns all the IBC connection ends of a chain.
fn connection_ends(&self) -> Result<Vec<IdentifiedConnectionEnd>, ContextError> {
let path = "connections".to_owned().into();

Expand Down Expand Up @@ -420,7 +420,7 @@ where
.collect()
}

Check warning on line 421 in ibc-testkit/src/testapp/ibc/core/core_ctx.rs

View check run for this annotation

Codecov / codecov/patch

ibc-testkit/src/testapp/ibc/core/core_ctx.rs#L407-L421

Added lines #L407 - L421 were not covered by tests

/// ClientConnections queries all the connection paths associated with a client.
/// Returns all the IBC connection ends associated with a client.
fn client_connection_ends(
&self,
client_id: &ClientId,
Expand All @@ -433,7 +433,7 @@ where
.unwrap_or_default())
}

Check warning on line 434 in ibc-testkit/src/testapp/ibc/core/core_ctx.rs

View check run for this annotation

Codecov / codecov/patch

ibc-testkit/src/testapp/ibc/core/core_ctx.rs#L424-L434

Added lines #L424 - L434 were not covered by tests

/// Channels queries all the IBC channels of a chain.
/// Returns all the IBC channel ends of a chain.
fn channel_ends(&self) -> Result<Vec<IdentifiedChannelEnd>, ContextError> {
let path = "channelEnds".to_owned().into();

Expand Down Expand Up @@ -464,7 +464,7 @@ where
.collect()
}

Check warning on line 465 in ibc-testkit/src/testapp/ibc/core/core_ctx.rs

View check run for this annotation

Codecov / codecov/patch

ibc-testkit/src/testapp/ibc/core/core_ctx.rs#L449-L465

Added lines #L449 - L465 were not covered by tests

/// PacketCommitments returns all the packet commitments associated with a channel.
/// Returns all the packet commitments associated with a channel.
fn packet_commitments(
&self,
channel_end_path: &ChannelEndPath,
Expand Down Expand Up @@ -505,8 +505,10 @@ where
.collect::<Result<Vec<_>, _>>()
}

Check warning on line 506 in ibc-testkit/src/testapp/ibc/core/core_ctx.rs

View check run for this annotation

Codecov / codecov/patch

ibc-testkit/src/testapp/ibc/core/core_ctx.rs#L490-L506

Added lines #L490 - L506 were not covered by tests

/// PacketAcknowledgements returns all the packet acknowledgements associated with a channel.
/// Returns all the packet acknowledgements if sequences is empty.
/// Returns the acknowledged packets associated with a channel.
///
/// Takes a sequence list as an argument.
/// If the list set is empty, it returns all acknowledged packets.
fn packet_acknowledgements(
&self,
channel_end_path: &ChannelEndPath,
Expand Down Expand Up @@ -560,8 +562,9 @@ where
.collect::<Result<Vec<_>, _>>()
}

Check warning on line 563 in ibc-testkit/src/testapp/ibc/core/core_ctx.rs

View check run for this annotation

Codecov / codecov/patch

ibc-testkit/src/testapp/ibc/core/core_ctx.rs#L546-L563

Added lines #L546 - L563 were not covered by tests

/// UnreceivedPackets returns all the unreceived IBC packets associated with
/// a channel and sequences.
/// Returns the unreceived IBC packets associated with a channel and sequences.
///
/// Takes a sequence list as an argument.
fn unreceived_packets(
&self,
channel_end_path: &ChannelEndPath,
Expand All @@ -583,8 +586,10 @@ where
.collect())
}

Check warning on line 587 in ibc-testkit/src/testapp/ibc/core/core_ctx.rs

View check run for this annotation

Codecov / codecov/patch

ibc-testkit/src/testapp/ibc/core/core_ctx.rs#L568-L587

Added lines #L568 - L587 were not covered by tests

/// UnreceivedAcks returns all the unreceived IBC acknowledgements associated with a channel and sequences.
/// Returns all the unreceived acks if sequences is empty.
/// Returns all the unreceived IBC acknowledgements associated with a channel and sequences.
///
/// Takes a sequence list as an argument.
/// If the list is empty, it Returns all the unreceived acks.
fn unreceived_acks(
&self,
channel_end_path: &ChannelEndPath,
Expand Down

0 comments on commit b8db190

Please sign in to comment.