citty icon indicating copy to clipboard operation
citty copied to clipboard

refactor: improve usage tips

Open kricsleo opened this issue 8 months ago • 1 comments

resolves #147

This PR aims to enhance the usage tips, making them more readable and less confusing.

  • Added (Default: ...) to descriptions when default: ... is set.
  • Moved (required) from the argument part to the description.
  • Added fallback value hints using snake_case names to avoid confusion when multiple args are displayed together (#147).

Mainly referenced https://clig.dev/

Looking forward to your feedbacks! ❤️

Before After
image image
image image
image image

kricsleo avatar Apr 08 '25 15:04 kricsleo

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Please upload report for BASE (main@6341dc3). Learn more about missing BASE report.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #198   +/-   ##
=======================================
  Coverage        ?   94.03%           
=======================================
  Files           ?        7           
  Lines           ?      520           
  Branches        ?      163           
=======================================
  Hits            ?      489           
  Misses          ?       31           
  Partials        ?        0           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov[bot] avatar Apr 09 '25 05:04 codecov[bot]