Document root workflow namespace omission - #1808
Closed
yuandrew wants to merge 1 commit into
Closed
Conversation
Root execution data omits the namespace, which may differ for cross-namespace child workflows. Warn users to retain it separately.
yuandrew
changed the title
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
1 participant
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
Document that root workflow execution information omits its namespace. The root namespace may differ for cross-namespace child workflows and must be tracked separately.
Why?
Completes the documentation requirement from temporalio/features#605.
Checklist
Closes
How was this tested:
Note
Low Risk
Docstring-only changes with no behavioral impact on the SDK.
Overview
Expands API docstrings so callers know root workflow execution info does not include the root’s namespace. For cross-namespace child workflows, that namespace can differ from the current workflow’s namespace and must be tracked separately.
On the client side,
WorkflowExecution.root_idandroot_run_idnow note that the root namespace is not retained. In workflow code, the same guidance appears onInfo.root,RootInfo, and contrasts withParentInfo, which still exposes parentnamespace.No runtime or type changes—documentation only, aligned with temporalio/features#605.
Reviewed by Cursor Bugbot for commit 2d48bb8. Bugbot is set up for automated code reviews on this repo. Configure here.