doc: clarify WithCloseOnContextDone closes api.Module #2221
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
Signed-off-by: Takeshi Yoneda <[email protected]>
mathetake
commented
May 28, 2024
| @@ -148,7 +148,7 @@ type RuntimeConfig interface { | |||
| // customSections := c.CustomSections() | |||
| WithCustomSections(bool) RuntimeConfig | |||
|
|
|||
| // WithCloseOnContextDone ensures the executions of functions to be closed under one of the following circumstances: | |||
| // WithCloseOnContextDone ensures the executions of functions to be terminated under one of the following circumstances: | |||
There was a problem hiding this comment.
closed was ambiguous as to what exactly will be closed, so use the different word, and clarified below.
lthibault
approved these changes
May 28, 2024
|
@lthibault thanks for the look! |
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.
This comes up in the discussion in the slack channel,
so this commit clarifies what exactly is closed on context cancelation.
cc @lthibault