Skip to content

[DOCS] Improve CLI help text for clarity and completeness#298

Open
RainRat wants to merge 1 commit intomainfrom
docs-improvement-cli-help-16631117226235601656
Open

[DOCS] Improve CLI help text for clarity and completeness#298
RainRat wants to merge 1 commit intomainfrom
docs-improvement-cli-help-16631117226235601656

Conversation

@RainRat
Copy link
Owner

@RainRat RainRat commented Feb 4, 2026

This PR improves the internal help strings of the evolverstage.py script. The primary changes involve overhauling the module docstring (which serves as the CLI --help text) to be more user-friendly, consistent, and comprehensive.

Key improvements:

  • Simplified Language: Replaced technical jargon with Plain English (e.g., "win streaks" instead of "log history").
  • Improved Structure: Reorganized commands into logical groups (General, Evolution, Battle Tools, Utilities) and adopted a clean [COMMAND] [OPTIONS] usage format.
  • Added Missing Options: Documented the -o/--output option for the --normalize command, which was previously missing from the help text.
  • Consistency: Ensured all commands and options are presented consistently, with clear explanations of default behaviors and common flags like --arena and --json.
  • Clarity: Added explicit examples for common tasks to help new users get started quickly.

These changes ensure the tool is more accessible to both developers and casual users, following the project's documentation guidelines.


PR created automatically by Jules for task 16631117226235601656 started by @RainRat

- Overhauled the module docstring in evolverstage.py to provide a clearer and more structured CLI help output.
- Simplified technical terms into Plain English for a global audience.
- Added missing documentation for the -o/--output option in the normalization tool.
- Improved visual hierarchy of the help text using logical categories.
- Clarified default behavior and common options like --arena and --json.

Co-authored-by: RainRat <20098977+RainRat@users.noreply.github.com>
@google-labs-jules
Copy link
Contributor

👋 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 @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

@chatgpt-codex-connector
Copy link

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.
To continue using code reviews, you can upgrade your account or add credits to your account and enable them for code reviews in your settings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant