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.

Sign up for GitHub

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

Jump to bottom

Document AppSetting::DisableVersion #589

Closed
brennie opened this issue Jul 23, 2016 · 2 comments
Closed

Document AppSetting::DisableVersion #589

brennie opened this issue Jul 23, 2016 · 2 comments
Labels
A-docs Area: documentation, including docs.rs, readme, examples, etc... C-enhancement Category: Raise on the bar on expectations

Comments

@brennie
Copy link
Contributor

brennie commented Jul 23, 2016

Currently, the AppSetting::DisableVersion setting is undocumented. From what I can tell, this setting is used to disable version flag on subcommand when the app (or super-command) uses AppSettings::VersionlessSubcommands.

However, if a user would like to not have a global -V, --version flag for their program, this setting will still work. I feel like this should be documented as it is genuinely useful.
@kbknapp
Copy link
Member

kbknapp commented Jul 23, 2016

@brennie It's used internally, and wasn't designed to be used publicly. This isn't to say it couldn't become public, but as of right now if one wishes to not have the -V, --version generated for subcommands, one can use AppSettings::VersionlessSubcommands

@brennie
Copy link
Contributor Author

brennie commented Jul 24, 2016

@kbknapp Yes, but I mean it could also be used to disable the -V, --version flag for the main App instance.

@kbknapp kbknapp added C-enhancement Category: Raise on the bar on expectations P4: nice to have A-docs Area: documentation, including docs.rs, readme, examples, etc... and removed T: RFC / question labels Aug 20, 2016
@nabijaczleweli nabijaczleweli mentioned this issue Sep 11, 2016
Merged
homu added a commit that referenced this issue Sep 11, 2016
@homu
Auto merge of #659 - nabijaczleweli:docs/appsettings/disableversion-d…
317402d 
…oc, r=kbknapp

Document AppSetting::DisableVersion

Closes #589
@homu homu closed this as completed in #659 Sep 11, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: documentation, including docs.rs, readme, examples, etc... C-enhancement Category: Raise on the bar on expectations
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@brennie @kbknapp