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

Document how boolean flags work #75

Open
janderland opened this issue Feb 6, 2024 · 1 comment
Open

Document how boolean flags work #75

janderland opened this issue Feb 6, 2024 · 1 comment

Comments

@janderland
Copy link

janderland commented Feb 6, 2024

It took me some time to figure out how the boolean flags work. The flag --truncate is set to true by default, but the CLI help message only includes info about what this flag does and lacks information on how to set it to false.

I went into the humanlog source code and opened up the docs for the latest version of the CLI library it uses (urfave/cli). This led me to try the flag with the no- prefix. This didn't work because humanlog isn't using the latest version of the library.

I also tried --truncate false which didn't work.

I finally found an issue which describes flags being used as --flag=true which led me to try --truncated=false.

Ideally, I wouldn't need to search through the issues of a dependent library to figure out how to use humanlog.

Thank you very much for all the work you've put into this tool.

@aybabtme
Copy link
Collaborator

aybabtme commented Apr 6, 2024

Thanks, I'll look at making this better. It trips me up as well.

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

No branches or pull requests

2 participants