Update docstring to use public alias for workflow.Execution
#752
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
In the docstring describing the async use of `ChildWorkflowExecution`, there is a reference to a type called `WorkflowExecution`. This is available in `internal`, but when it is exported through the `workflow` package, it is actually renamed to `workflow.Execution`. See: https://github.com/temporalio/sdk-go/blob/c453756356db4e5ae9fcabd416a6a8e57db5cc35/workflow/workflow.go#L45
psigen
requested review from
mfateev,
Sushisource,
alexshtin,
Spikhalskiy,
bergundy,
cretz and
mmcshane
as code owners
|
|
cretz
approved these changes
Mar 21, 2022
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.
What was changed
Changed docstring to refer to
workflow.Executioninstead ofWorkflowExecution.Why?
In the docstring describing the async use of
ChildWorkflowExecution, there is a reference to a typecalled
WorkflowExecution. This is available ininternal, but when it is exported through theworkflowpackage, it is actually renamed to
workflow.Execution.See:
sdk-go/workflow/workflow.go
Line 45 in c453756
Checklist