Skip to content

Commit e149424

Browse files
committed
Fix docstrings
1 parent 4191195 commit e149424

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

rclrs/src/node/client.rs

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -198,13 +198,14 @@ where
198198
Ok(rx.await.unwrap())
199199
}
200200

201-
// Fetches a new response.
202-
//
203-
// When there is no new message, this will return a
204-
// [`ClientTakeFailed`][1].
205-
//
206-
// [1]: crate::RclrsError
201+
/// Fetches a new response.
202+
///
203+
/// When there is no new message, this will return a
204+
/// [`ClientTakeFailed`][1].
205+
///
206+
/// [1]: crate::RclrsError
207207
//
208+
// ```text
208209
// +----------------------+
209210
// | rclrs::take_response |
210211
// +----------+-----------+
@@ -218,6 +219,7 @@ where
218219
// +----------v----------+
219220
// | rmw_take |
220221
// +---------------------+
222+
// ```
221223
pub fn take_response(&self) -> Result<(T::Response, rmw_request_id_t), RclrsError> {
222224
let mut request_id_out = rmw_request_id_t {
223225
writer_guid: [0; 16],

rclrs/src/node/service.rs

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -110,13 +110,14 @@ where
110110
})
111111
}
112112

113-
// Fetches a new request.
114-
//
115-
// When there is no new message, this will return a
116-
// [`ServiceTakeFailed`][1].
117-
//
118-
// [1]: crate::RclrsError
113+
/// Fetches a new request.
114+
///
115+
/// When there is no new message, this will return a
116+
/// [`ServiceTakeFailed`][1].
117+
///
118+
/// [1]: crate::RclrsError
119119
//
120+
// ```text
120121
// +---------------------+
121122
// | rclrs::take_request |
122123
// +----------+----------+
@@ -130,6 +131,7 @@ where
130131
// +----------v----------+
131132
// | rmw_take |
132133
// +---------------------+
134+
// ```
133135
pub fn take_request(&self) -> Result<(T::Request, rmw_request_id_t), RclrsError> {
134136
let mut request_id_out = rmw_request_id_t {
135137
writer_guid: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],

0 commit comments

Comments
 (0)