Skip to content

refactor: improve usage tips #198

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

kricsleo
Copy link
Member

@kricsleo kricsleo commented Apr 8, 2025

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 (Improve arg help usage message (placeholder) #147).

Mainly referenced https://clig.dev/

Looking forward to your feedbacks! ❤️

Before After
image image
image image
image image

Copy link

codecov bot commented Apr 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

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           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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

@kricsleo kricsleo marked this pull request as ready for review April 9, 2025 05:40
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.

Improve arg help usage message (placeholder)
1 participant