Skip to content

Commit 4191195

Browse files
committed
Use double slashes for comments for take_* functions
1 parent 679b028 commit 4191195

File tree

2 files changed

+40
-35
lines changed

2 files changed

+40
-35
lines changed

rclrs/src/node/client.rs

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -198,26 +198,26 @@ 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
207-
///
208-
/// +----------------------+
209-
/// | rclrs::take_response |
210-
/// +----------+-----------+
211-
/// |
212-
/// |
213-
/// +----------v-----------+
214-
/// | rcl_take_response |
215-
/// +----------+-----------+
216-
/// |
217-
/// |
218-
/// +----------v----------+
219-
/// | rmw_take |
220-
/// +---------------------+
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
207+
//
208+
// +----------------------+
209+
// | rclrs::take_response |
210+
// +----------+-----------+
211+
// |
212+
// |
213+
// +----------v-----------+
214+
// | rcl_take_response |
215+
// +----------+-----------+
216+
// |
217+
// |
218+
// +----------v----------+
219+
// | rmw_take |
220+
// +---------------------+
221221
pub fn take_response(&self) -> Result<(T::Response, rmw_request_id_t), RclrsError> {
222222
let mut request_id_out = rmw_request_id_t {
223223
writer_guid: [0; 16],

rclrs/src/node/service.rs

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -110,21 +110,26 @@ where
110110
})
111111
}
112112

113-
/// Ask RMW for the data
114-
///
115-
/// +---------------------+
116-
/// | rclrs::take_request |
117-
/// +----------+----------+
118-
/// |
119-
/// |
120-
/// +----------v----------+
121-
/// | rcl_take_request |
122-
/// +----------+----------+
123-
/// |
124-
/// |
125-
/// +----------v----------+
126-
/// | rmw_take |
127-
/// +---------------------+
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
119+
//
120+
// +---------------------+
121+
// | rclrs::take_request |
122+
// +----------+----------+
123+
// |
124+
// |
125+
// +----------v----------+
126+
// | rcl_take_request |
127+
// +----------+----------+
128+
// |
129+
// |
130+
// +----------v----------+
131+
// | rmw_take |
132+
// +---------------------+
128133
pub fn take_request(&self) -> Result<(T::Request, rmw_request_id_t), RclrsError> {
129134
let mut request_id_out = rmw_request_id_t {
130135
writer_guid: [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],

0 commit comments

Comments
 (0)