Please use bold font for keywords in SFDK "man page"

In the paginated help that you see with sfdk --help it is pretty hard to just skim through for what you are looking for, since there is no visual distinction between keywords and their descriptions. Most man pages has this so you have an easier time finding the option you are looking for, and only then having to bother to look at the description (as it is easily distinguished).

Screenshot from 2021-01-16 12-50-36

I also have some choice cursewords for forced pagination by default and not accepting -h for help, but that’s not really productive to worry about, so i will try not to.

One could argue that this is still help printout and not a man page, despite the pagination, so that bold is not commonplace. But in that case, please consider making the separation between option and description more clear some other way, e.g. by putting them in columns, not just separated with two spaces.

4 Likes

Sailfish SDK 3.7 renders built-in help as man pages wherever possible, addressing this issue as well.

3 Likes