Skip to content
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

Better help messages #364

Open
hydrargyrum opened this issue Sep 1, 2019 · 1 comment
Open

Better help messages #364

hydrargyrum opened this issue Sep 1, 2019 · 1 comment
Labels
docs leading to more and improved documentation wish feature we wish someone would refine and implement

Comments

@hydrargyrum
Copy link

The manpage tomb(1) mentions "tomb dig" but doesn't tell what are the arguments and in what order.

% tomb dig        
tomb  .  Commanded to dig tomb 
tomb [E] Missing path to tomb
% tomb dig my.tomb
tomb  .  Commanded to dig tomb my.tomb
tomb [E] Tombs can't be smaller than 10 mebibytes
% tomb dig my.tomb 10
tomb  .  Commanded to dig tomb my.tomb
tomb [E] Tombs can't be smaller than 10 mebibytes
% tomb dig -h     
tomb  .  Commanded to dig tomb 
tomb [E] Missing path to tomb

tomb dig -h should give the subcommand help and the manpage should mention expected args for a subcommand.

@jaromil jaromil added docs leading to more and improved documentation wish feature we wish someone would refine and implement labels Nov 13, 2020
@jaromil
Copy link
Member

jaromil commented Jun 24, 2021

planning to do a usage_help() internal function called by fatal errors printing out a usage example string for each subcommand when failing.

subcommand help is a bit too much work refactoring the old cli, but will take into account for v3

@jaromil jaromil added this to the portable milestone Nov 14, 2022
@jaromil jaromil removed this from the portable milestone May 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs leading to more and improved documentation wish feature we wish someone would refine and implement
Projects
None yet
Development

No branches or pull requests

2 participants