Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
Signed-off-by: Michael X. Grey <greyxmike@gmail.com>
  • Loading branch information
mxgrey committed Nov 20, 2024
1 parent daebaa8 commit 126aaca
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 6 deletions.
2 changes: 1 addition & 1 deletion rclrs/src/client.rs
Original file line number Diff line number Diff line change
Expand Up @@ -284,7 +284,7 @@ where
/// `ClientOptions` are used by [`Node::create_client`][1] to initialize a
/// [`Client`] for a service.
///
/// [1]: crate::NodeState::create_client
/// [1]: crate::Node::create_client
#[derive(Debug, Clone)]
#[non_exhaustive]
pub struct ClientOptions<'a> {
Expand Down
8 changes: 5 additions & 3 deletions rclrs/src/node.rs
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ impl Node {
unsafe { call_string_getter_with_rcl_node(&rcl_node, getter) }
}

/// Creates a [`Client`][1].
/// Creates a [`Client`].
///
/// Pass in only the service name for the `options` argument to use all default client options:
/// ```
Expand Down Expand Up @@ -230,8 +230,10 @@ impl Node {
/// Any quality of service options that you explicitly specify will override
/// the default service options. Any that you do not explicitly specify will
/// remain the default service options. Note that clients are generally
/// expected to use [reliable][2], so it's best not to change the reliability
/// expected to use [reliable][1], so it's best not to change the reliability
/// setting unless you know what you are doing.
///
/// [1]: crate::QoSReliabilityPolicy::Reliable
pub fn create_client<'a, T>(
&self,
options: impl Into<ClientOptions<'a>>,
Expand Down Expand Up @@ -389,7 +391,7 @@ impl Node {
Ok(service)
}

/// Creates a [`Subscription`][1].
/// Creates a [`Subscription`].
///
///
/// Pass in only the topic name for the `options` argument to use all default subscription options:
Expand Down
2 changes: 1 addition & 1 deletion rclrs/src/publisher.rs
Original file line number Diff line number Diff line change
Expand Up @@ -234,7 +234,7 @@ where
/// `PublisherOptions` are used by [`Node::create_publisher`][1] to initialize
/// a [`Publisher`].
///
/// [1]: crate::NodeState::create_publisher
/// [1]: crate::Node::create_publisher
#[derive(Debug, Clone)]
#[non_exhaustive]
pub struct PublisherOptions<'a> {
Expand Down
4 changes: 3 additions & 1 deletion rclrs/src/subscription.rs
Original file line number Diff line number Diff line change
Expand Up @@ -263,8 +263,10 @@ where
}
}

/// `SubscriptionOptions` are used by [`Node::create_subscription`] to initialize
/// `SubscriptionOptions` are used by [`Node::create_subscription`][1] to initialize
/// a [`Subscription`].
///
/// [1]: crate::Node::create_subscription
#[derive(Debug, Clone)]
#[non_exhaustive]
pub struct SubscriptionOptions<'a> {
Expand Down

0 comments on commit 126aaca

Please sign in to comment.