CLAP icon indicating copy to clipboard operation
CLAP copied to clipboard

Help text of parameters not displayed

Open mrcouthy opened this issue 10 years ago • 3 comments

The help text of parameters is not being displayed .. eg for [Parameter(Description = "A bool parameter, which can be used as a switch")] bool verbose,

when we type abc.exe help on command line It displays text of description from methods only and not the ones from the parameter.

mrcouthy avatar Apr 09 '15 06:04 mrcouthy

The [Parameter] attribute, along with its Description property are both obsolete. You should get a compilation warning. Please use the [Description] attribute instead. There is no need for the [Parameter] attribute.

adrianaisemberg avatar Apr 09 '15 07:04 adrianaisemberg

@adrianaisemberg I was just bitten by this as well. I think the misconceptions stem from the website here: http://adrianaisemberg.github.io/CLAP/#attributes. Do you think it would be a good idea to add a notice to the site indicating updated documentation is available on the GitHub page?

masaeedu avatar May 15 '15 18:05 masaeedu

I agree. I need to find time to update the docs.

adrianaisemberg avatar Jun 01 '15 17:06 adrianaisemberg