Repository navigation
UX: Standardize CLI help text for JSON output flags (Draft) - #693
Conversation
Co-authored-by: tteon <52625664+tteon@users.noreply.github.com>
|
👋 Jules, reporting for duty! I'm here to lend a hand with this pull request. When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down. I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job! For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with New to Jules? Learn more at jules.google/docs. For security, I will only act on instructions from the user who triggered this task. |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 90dfcd8b09
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Co-authored-by: tteon <52625664+tteon@users.noreply.github.com>
What
Standardizes the
helptext for all--jsonCLI arguments to be exclusively"Emit JSON".Why
The previous CLI definitions for the
--jsonoutput flag had inconsistent help strings (e.g.,"JSON output","Emit JSON output", missing descriptions entirely, or"Emit JSON"). This standardization simplifies the CLI help surface, providing a more consistent operator experience per the repository's UX constraints.Accessibility / UX Impact
Minor but clear UX improvement: Reduces cognitive load for CLI users by guaranteeing that the identical functional flag (
--json) is described identically across every single command and subcommand.Validation
bash scripts/ci/run_basic_ci.shlocally. The basic CI suite completed, and the only failures were 3 tests inextraction/tests/test_tools.pywhich are an unrelated, pre-existing issue on the main branch regardingRunContextWrapper. My modifications do not cause functional regressions.bash scripts/pm/lint-agent-docs.sh, which confirms the agent docs/CLI contracts remain solid.Risks
Extremely low risk. This change exclusively alters static CLI
helpstring literals. It does not modify flag names, target destinations, defaults, boolean action flags, or underlying runtime logic.Modified Files:
src/seocho/cli/ontology.pysrc/seocho/cli/options.pysrc/seocho/cli/parsers.pysrc/seocho/cli/runs.py.jules/palette.md(Note: Created as a Draft PR as requested by repository issue guidelines.)
PR created automatically by Jules for task 1760517736953239750 started by @tteon