Docstring specifying proper destruction and creation of Rate, Timer and GuardCondition#1286
Merged
sloretz merged 8 commits intoros2:rollingfrom Jun 14, 2024
Merged
Docstring specifying proper destruction and creation of Rate, Timer and GuardCondition#1286sloretz merged 8 commits intoros2:rollingfrom
sloretz merged 8 commits intoros2:rollingfrom
Conversation
Contributor
Author
|
I wonder if I should also add this to Iron and humble branch? |
Signed-off-by: elian-WSL22H <elian.neppel@posteo.eu>
Signed-off-by: elian-WSL22H <elian.neppel@posteo.eu>
Signed-off-by: elian-WSL22H <elian.neppel@posteo.eu>
Signed-off-by: elian-WSL22H <elian.neppel@posteo.eu>
Collaborator
fujitatomoya
left a comment
fujitatomoya
left a comment
There was a problem hiding this comment.
lgtm with indent fixes.
Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> Signed-off-by: Elian NEPPEL <70491689+hubble14567@users.noreply.github.com>
Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> Signed-off-by: Elian NEPPEL <70491689+hubble14567@users.noreply.github.com>
Contributor
Author
|
lgtm, indeed better this way. |
This reverts commit fd61446. Signed-off-by: elian-WSL22H <elian.neppel@posteo.eu>
This reverts commit 0fb83ca. Co-authored-by: Tomoya Fujita <Tomoya.Fujita@sony.com> Signed-off-by: elian-WSL22H <elian.neppel@posteo.eu>
Contributor
Author
|
Ok I don't know why the tests failed on fd61446, anyway they passed. |
sloretz
approved these changes
Jun 14, 2024
Contributor
sloretz
left a comment
sloretz
left a comment
There was a problem hiding this comment.
Thank you for the docstring improvements!
Contributor
|
CI (repos file build:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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,TimerandGuardConditionRate,TimerandGuardCondition.create_rateand.create_guard_conditionmethods of NodeSubscriber,Publisherand 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_rateand.create_guard_conditionmethods ofNodebecause, 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.