question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add a command-line arg to output rationales along with check results?

See original GitHub issue

Observed behaviour

The checks show a basic doc string in the cli output, for example:

check

Expected behaviour

There is additional information in the rationale that can be very helpful, for example:

rational

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:closed
  • Created 4 years ago
  • Comments:7 (7 by maintainers)

github_iconTop GitHub Comments

1reaction
eliheuercommented, Oct 23, 2019

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.

1reaction
felipesanchescommented, Oct 23, 2019

I’d advocate for making it the default behaviour and then maybe add a --hide-rationale command-line arg.

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found