Docstring specifying proper destruction and creation of Rate, Timer and GuardCondition
This commit stems from my issue and discussion here
I added explanation of how the user should handle the destruction and creation of the object in the docstrings of the:
- constructor of
Rate,TimerandGuardCondition - .destroy methods of
Rate,TimerandGuardCondition .create_rateand.create_guard_conditionmethods of Node
Subscriber, Publisher and other objects share the same destruction process. However they already had proper warnings in their docstrings. So no changes were required for those. I have kept my new docstring consistent with those.
I have decided to only change .create_rate and .create_guard_condition methods of Node because, those are the most likely objects to be destroyed and had a very short docstrings. Adding the warning in the already long create_publisher, etc, did not seem right.
I wonder if I should also add this to Iron and humble branch?
lgtm, indeed better this way.
Ok I don't know why the tests failed on fd61446, anyway they passed.
CI (repos file build: --packages-up-to rclpy test: --packages-select rclpy)