Re: patch to improve opthelp method

 new new list compose Reply to this message Top page
Attachments:
+ (text/plain)

Delete this message
Author: Kaz Kylheku
Date:  
To: vapnik spaknik
CC: txr-users
Subject: Re: patch to improve opthelp method
On 2022-02-03 17:48, vapnik spaknik wrote:
> Hi Kaz,
>            I find the extra notes printed by opthelp about command
> line argument processing conventions to be superfluous.


Hi Joe,

Thanks for the feedback. I've cleaned up the white space issues in the
patch and made some minor changes, plus merged it with Paul's changes.

Though I'm not sure if it it will be retained in the current form.

I'm probably going to just split it up into multiple functions/methods:

opthelp: just the help

opthelp-conventions: print the notes about the argument conventions

opthelp-types: print the type legend.

While the notes is verbose and unnecessary to someone who generally
knows
how to use command line options, the type legend could be of help to
the user; I don't like it being disabled together.

The type legend only shows help for the types actually present in the
options; it can be very short if the program is only using a couple of
types.

Without it, the user might not guess what is a CINT or whatever.