Skip to content

Commit 16b21f3

Browse files
committed
Revise the description
Signed-off-by: Barry Xu <barry.xu@sony.com>
1 parent eda6e2c commit 16b21f3

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

rclcpp/include/rclcpp/publisher_base.hpp

+4-4
Original file line numberDiff line numberDiff line change
@@ -211,17 +211,17 @@ class PublisherBase : public std::enable_shared_from_this<PublisherBase>
211211
* subscriptions or the given timeout elapses.
212212
*
213213
* If the timeout is negative then this method will block indefinitely until all published
214-
* message data are acknowledged.
214+
* messages are acknowledged.
215215
* If the timeout is zero then this method will not block, it will check if all published
216-
* messages were acknowledged and return immediately.
216+
* messages are acknowledged and return immediately.
217217
* If the timeout is greater than zero, this method will wait until all published messages are
218218
* acknowledged or the timeout elapses.
219219
*
220220
* This method only waits for acknowledgments if the publisher's QoS profile is RELIABLE.
221221
* Otherwise this method will immediately return `true`.
222222
*
223-
* \param[in] timeout the duration to wait for all published message data to be acknowledged.
224-
* \return `true` if all published message data were acknowledged before the given timeout
223+
* \param[in] timeout the duration to wait for all published messages to be acknowledged.
224+
* \return `true` if all published messages were acknowledged before the given timeout
225225
* elapsed, otherwise `false`.
226226
* \throws rclcpp::exceptions::RCLError if middleware doesn't support or internal error occurs
227227
* \throws std::invalid_argument if timeout is greater than std::chrono::nanoseconds::max() or

0 commit comments

Comments
 (0)