Skip to content

Commit 1bdb9ae

Browse files
author
GueLaKais
committed
Get rid of documentation warnings.
Documentation warnings are annoying. So i've get rid of them.
1 parent 05a1312 commit 1bdb9ae

File tree

4 files changed

+19
-19
lines changed

4 files changed

+19
-19
lines changed

rclrs/src/parameter.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -696,9 +696,9 @@ impl<'a> Parameters<'a> {
696696
/// Returns:
697697
/// * `Ok(())` if setting was successful.
698698
/// * [`Err(DeclarationError::TypeMismatch)`] if the type of the requested value is different
699-
/// from the parameter's type.
699+
/// from the parameter's type.
700700
/// * [`Err(DeclarationError::OutOfRange)`] if the requested value is out of the parameter's
701-
/// range.
701+
/// range.
702702
/// * [`Err(DeclarationError::ReadOnly)`] if the parameter is read only.
703703
pub fn set<T: ParameterVariant>(
704704
&self,

rclrs/src/parameter/range.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ impl From<()> for ParameterRanges {
3232
/// Usually only one of these ranges will be applied, but all have to be stored since:
3333
///
3434
/// * A dynamic parameter can change its type at runtime, in which case a different range could be
35-
/// applied.
35+
/// applied.
3636
/// * Introspection through service calls requires all the ranges to be reported to the user.
3737
#[derive(Clone, Debug, Default)]
3838
pub struct ParameterRanges {

rclrs/src/subscription/message_info.rs

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,23 @@ use crate::rcl_bindings::*;
77
/// To quote the `rmw` documentation:
88
///
99
/// > The identifier uniquely identifies the publisher for the local context, but
10-
/// it will not necessarily be the same identifier given in other contexts or processes
11-
/// for the same publisher.
12-
/// Therefore the identifier will uniquely identify the publisher within your application
13-
/// but may disagree about the identifier for that publisher when compared to another
14-
/// application.
15-
/// Even with this limitation, when combined with the publisher sequence number it can
16-
/// uniquely identify a message within your local context.
17-
/// Publisher GIDs generated by the RMW implementation could collide at some point, in which
18-
/// case it is not possible to distinguish which publisher sent the message.
19-
/// The details of how GIDs are generated are RMW implementation dependent.
10+
/// > it will not necessarily be the same identifier given in other contexts or processes
11+
/// > for the same publisher.
12+
/// > Therefore the identifier will uniquely identify the publisher within your application
13+
/// > but may disagree about the identifier for that publisher when compared to another
14+
/// > application.
15+
/// > Even with this limitation, when combined with the publisher sequence number it can
16+
/// > uniquely identify a message within your local context.
17+
/// > Publisher GIDs generated by the RMW implementation could collide at some point, in which
18+
/// > case it is not possible to distinguish which publisher sent the message.
19+
/// > The details of how GIDs are generated are RMW implementation dependent.
2020
///
2121
/// > It is possible the the RMW implementation needs to reuse a publisher GID,
22-
/// due to running out of unique identifiers or some other constraint, in which case
23-
/// the RMW implementation may document what happens in that case, but that
24-
/// behavior is not defined here.
25-
/// However, this should be avoided, if at all possible, by the RMW implementation,
26-
/// and should be unlikely to happen in practice.
22+
/// > due to running out of unique identifiers or some other constraint, in which case
23+
/// > the RMW implementation may document what happens in that case, but that
24+
/// > behavior is not defined here.
25+
/// > However, this should be avoided, if at all possible, by the RMW implementation,
26+
/// > and should be unlikely to happen in practice.
2727
#[derive(Clone, Debug, PartialEq, Eq)]
2828
pub struct PublisherGid {
2929
/// Bytes identifying a publisher in the RMW implementation.

rclrs/src/wait.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -329,7 +329,7 @@ impl WaitSet {
329329
///
330330
/// - Passing a wait set with no wait-able items in it will return an error.
331331
/// - The timeout must not be so large so as to overflow an `i64` with its nanosecond
332-
/// representation, or an error will occur.
332+
/// representation, or an error will occur.
333333
///
334334
/// This list is not comprehensive, since further errors may occur in the `rmw` or `rcl` layers.
335335
///

0 commit comments

Comments
 (0)