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

Referring to arguments in documentation. #91

Closed
rleonid opened this issue Jan 16, 2018 · 2 comments
Closed

Referring to arguments in documentation. #91

rleonid opened this issue Jan 16, 2018 · 2 comments

Comments

@rleonid
Copy link
Contributor

rleonid commented Jan 16, 2018

Apologies if this is mentioned in the documentation, but what is the recommended way to consistently refer to arguments in documentation?

For example if I have a flag --do-it-this-way, I usually define a variable with value "do-it-this-way" and then sprintf it into the documentation (such as in an examples or doc of another argument). This is a bit tedious and I wonder if cmdliner supports a better pattern?

@dbuenzli
Copy link
Owner

In the doc of an option itself you can use $(opt) as mentioned here. Other than there's nothing else you can do. There was a plan for this but TBH I find that a bit overkill.

@rleonid
Copy link
Contributor Author

rleonid commented Jan 17, 2018

I see, the plan looks good to me and would be useful to me. As has this library in general, so thank you!

@rleonid rleonid closed this as completed Jan 17, 2018
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

2 participants