Clearly document lifetime expectations for CommandSender. #7067
Conversation
This file contains 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
pullapprove
bot
requested review from
andy31415,
chrisdecenzo,
Damian-Nordic,
hawk248,
jepenven-silabs,
kedars,
msandstedt and
woody-apple
msandstedt
approved these changes
May 24, 2021
saurabhst
approved these changes
May 24, 2021
andy31415
approved these changes
May 25, 2021
andy31415
reviewed
May 25, 2021
| @@ -100,7 +100,7 @@ class InteractionModelEngine : public Messaging::ExchangeDelegate | |||
|
|
|||
| /** | |||
| * Retrieve a CommandSender that the SDK consumer can use to send a set of commands. If the call succeeds, | |||
| * the consumer is responsible for calling Shutdown() on the CommandSender once it's done using it. | |||
| * see CommandSender documentation for lifetime handling. | |||
There was a problem hiding this comment.
nit: redirecting from a doc to another doc is generally somewhat inconvenient for reads of code. Don't have a better suggestion though beside some more invasive changes that would not require documentation to figure out lifetime (smart-pointer/handle usage).
There was a problem hiding this comment.
Yeah, I was not too happy about this either, not least because it's not pointing directly at the relevant docs over there, but if I did that I'd be pointing to a function name that can also change... I couldn't find a nicer solution just with documentation, unfortunately. :(
andy31415
approved these changes
May 25, 2021
jelderton
approved these changes
May 25, 2021
nikita-s-wrk
pushed a commit
to nikita-s-wrk/connectedhomeip
that referenced
this pull request
Sep 23, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
Documentation for CommandSender lifetime does not match reality.
Change overview
Fix the documentation
Testing
Comment-only change, no functional changes.