Skip to content

Commit 126aaca

Browse files
committed
Fix docs
Signed-off-by: Michael X. Grey <[email protected]>
1 parent daebaa8 commit 126aaca

File tree

4 files changed

+10
-6
lines changed

4 files changed

+10
-6
lines changed

rclrs/src/client.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -284,7 +284,7 @@ where
284284
/// `ClientOptions` are used by [`Node::create_client`][1] to initialize a
285285
/// [`Client`] for a service.
286286
///
287-
/// [1]: crate::NodeState::create_client
287+
/// [1]: crate::Node::create_client
288288
#[derive(Debug, Clone)]
289289
#[non_exhaustive]
290290
pub struct ClientOptions<'a> {

rclrs/src/node.rs

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ impl Node {
199199
unsafe { call_string_getter_with_rcl_node(&rcl_node, getter) }
200200
}
201201

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

392-
/// Creates a [`Subscription`][1].
394+
/// Creates a [`Subscription`].
393395
///
394396
///
395397
/// Pass in only the topic name for the `options` argument to use all default subscription options:

rclrs/src/publisher.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,7 @@ where
234234
/// `PublisherOptions` are used by [`Node::create_publisher`][1] to initialize
235235
/// a [`Publisher`].
236236
///
237-
/// [1]: crate::NodeState::create_publisher
237+
/// [1]: crate::Node::create_publisher
238238
#[derive(Debug, Clone)]
239239
#[non_exhaustive]
240240
pub struct PublisherOptions<'a> {

rclrs/src/subscription.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,8 +263,10 @@ where
263263
}
264264
}
265265

266-
/// `SubscriptionOptions` are used by [`Node::create_subscription`] to initialize
266+
/// `SubscriptionOptions` are used by [`Node::create_subscription`][1] to initialize
267267
/// a [`Subscription`].
268+
///
269+
/// [1]: crate::Node::create_subscription
268270
#[derive(Debug, Clone)]
269271
#[non_exhaustive]
270272
pub struct SubscriptionOptions<'a> {

0 commit comments

Comments
 (0)