-
Notifications
You must be signed in to change notification settings - Fork 521
Improved docstring for get_rmw_qos_profile() #2777
Copy link
Copy link
Closed
Description
The current docstrings for get_rmw_qos_profile() don't provide any more information than the obvious. How to make them better? I know next to nothing about middlewares, but I'm happy to submit improvements if they are welcome.
rclcpp/rclcpp/include/rclcpp/qos.hpp
Lines 148 to 154 in 1564fc2
| /// Return the rmw qos profile. | |
| rmw_qos_profile_t & | |
| get_rmw_qos_profile(); | |
| /// Return the rmw qos profile. | |
| const rmw_qos_profile_t & | |
| get_rmw_qos_profile() const; |
(my) Motivation: I was going through the tutorial on Approximate Time Synchronizer and noticed these lines:
rclcpp::QoS qos = rclcpp::QoS(10);
temp_pub = this->create_publisher<sensor_msgs::msg::Temperature>("temp", qos);
fluid_pub = this->create_publisher<sensor_msgs::msg::FluidPressure>("fluid", qos);
temp_sub.subscribe(this, "temp", qos.get_rmw_qos_profile());
fluid_sub.subscribe(this, "fluid", qos.get_rmw_qos_profile());
I wanted to find out more on get_rmw_qos_profile and found the docstring not telling me much. The documentation is not more informative either.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels