I added explanation of how the user should handle the destruction and creation of the object in the docstrings of the:
constructor of Rate, Timer and GuardCondition
.destroy methods of Rate, Timer and GuardCondition
.create_rate and .create_guard_condition methods 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.
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:
Rate
,Timer
andGuardCondition
Rate
,Timer
andGuardCondition
.create_rate
and.create_guard_condition
methods of NodeSubscriber
,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 ofNode
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.