Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Help text of parameters not displayed #33

Open
mrcouthy opened this issue Apr 9, 2015 · 3 comments
Open

Help text of parameters not displayed #33

mrcouthy opened this issue Apr 9, 2015 · 3 comments

Comments

@mrcouthy
Copy link

mrcouthy commented Apr 9, 2015

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 mrcouthy changed the title Help text of attributes not displayed Help text of parameters not displayed Apr 9, 2015
@adrianaisemberg
Copy link
Owner

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.

@masaeedu
Copy link

@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?

@adrianaisemberg
Copy link
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants