Repository navigation
docs(cli): enrich describe/invoke help text with routing examples - #89
Merged
Merged
Conversation
Add worked examples (synergy.new_project, find_plot_by_name.plot_name, step.param.attr=value routing) to the describe/invoke command help so users discover the CLI's dotted-target and chained-parameter syntax directly from --help, without needing external docs. Also harden the two tests asserting on this help text against environment-dependent flakiness: force English locale and a wide terminal width before invoking, since Rich/Click help rendering can otherwise omit or blank argument descriptions depending on the active gettext locale and detected console width. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
release/27 is not taking further changes; the Unreleased section had been all-N/A placeholders with nothing pending, and its presence was contributing to confusing sync-triggered diffs against downstream forks. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
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.
Summary
describe/invokeCLI commands'--helptext with worked examples of the dotted-target and chained-parameter routing syntax (synergy.new_project,find_plot_by_name.plot_name,step.param.attr=value).internal/release/27, tracked as IM-14865/PR #192) to keep CI green there; without landing it here too, the next inward-sync PR reverts it every cycle.test_help_and_describe_show_snake_case_targetsandtest_invoke_help_shows_arg_syntaxagainst environment-dependent flakiness (locale leakage from other tests, narrow detected terminal width) that was masking the real assertions on CI.Test plan
pytest tests/api/unit_tests/test_cli_describe.py tests/api/unit_tests/test_cli_invoke_parse.py— 110 passed locally.