docs: fix invalid schedule update example#1120
Open
chaptersix wants to merge 2 commits into
Open
Conversation
The schedule update example used --workflow-type, which is not a valid flag. The correct flag is --type. Since update performs a full replacement, --type and --task-queue are also required, so the example was incomplete. Update it to mirror the valid schedule create example.
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
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
The
temporal schedule updateexample used--workflow-type, which is not a valid flag. The correct flag is--type(alias--name), from theshared-workflow-startoption set.Additionally, since
schedule updateperforms a full replacement of the configuration, both--typeand--task-queueare required. The old example was therefore also incomplete.Before
After
This mirrors the valid
schedule createexample.How
internal/temporalcli/commands.yamlinternal/temporalcli/commands.gen.goviamake genAudit
I also validated every other command's example flags against each command's real flag set (extracted from
--help). The schedule update example was the only invalid one; all other examples reference flags that exist. Relevant tests pass.