Add a command-line arg to output rationales along with check results?
See original GitHub issueObserved behaviour
The checks show a basic doc string in the cli output, for example:
Expected behaviour
There is additional information in the rationale that can be very helpful, for example:
When fixing FAILS
and WARNS
users sometimes need to look at the rationale in the source code to get more context on issues. It isn’t initially clear that you can or should do this.
We could add the rationale to the CLI output, which would make the output more verbose but might make using fontbakery easier for new users. For more experienced FontBakery users a flag could be used to hide the rationale part of the output.
Issue Analytics
- State:
- Created 4 years ago
- Comments:7 (7 by maintainers)
Top Results From Across the Web
Command line arguments in C/C++ - GeeksforGeeks
argv(ARGument Vector) is array of character pointers listing all the arguments. If argc is greater than zero,the array elements from argv[0] to ...
Read more >How to prompt for user input and read command-line arguments
To read user input you can try the cmd module for easily creating a mini-command line interpreter (with help texts and autocompletion) and...
Read more >argparse — Parser for command-line options, arguments and ...
The ArgumentParser object will hold all the information necessary to parse the command line into Python data types. Adding arguments¶. Filling an ArgumentParser ......
Read more >Adding arguments and options to your Bash scripts - Red Hat
Bash uses a tool called positional parameters to provide a means of entering data into a Bash program when it is invoked from...
Read more >2. Shell Command Language
If the first line of a file of shell commands starts with the characters "#!" ... use of the <colon> in the format...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Yeah, I like that, making it default would work. It would make it easier to notice when a rationale needs work and might push users to keep rationales updated and fill in the missing information.
I’d advocate for making it the default behaviour and then maybe add a
--hide-rationale
command-line arg.