arcanis / clipanion

Type-safe CLI library / framework with no runtime dependencies
https://mael.dev/clipanion/
1.1k stars 61 forks source link

Update help.md with correct --help usage #162

Closed yoannmoinet closed 3 months ago

yoannmoinet commented 3 months ago

The documentation isn't aligned with the builtin help.

The Builtin doc talks about a --help flag.

But the Help command doc talks about a full fledged help command.

Spoiler alert, the help command doesn't work and prints an error. The --help flag is what works.

This PR fixes this and update the Help command doc.

[!WARNING] I'm not sure how the #the-help-command will be updated, or if it's in use somewhere else.

[!NOTE] The Edit this page link isn't working as expected.