-
Notifications
You must be signed in to change notification settings - Fork 414
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
Documentation is inconsistent. #867
Comments
Thanks for pointing this out. I’ll improve the docs. Can you point me to specific deprecated examples? |
I updated the Boolean Options section of the user manual. Is this sufficient? (Also please let me know which deprecated example code needs updating.) |
Thank you very much, Remko.
I would have preferred it if you had mentioned that since 4.0, the
behaviour is to toggle the default value as against the current value in
prior versions.
The examples seem to have been updated since.
https://github.com/Fernal73/LearnJava/tree/master/Picocli
I haven't explored picocli completely. Does it support properties (not @files) and can these be overridden via the command line? The documentation doesn't provide detailed information.
A full-fledged example for the Defaults provider with how it works with overriding (if supported) would be useful.
|
@Fernal73 I updated the boolean options section to clarify further. I hope this is better. (I did not realize you edited your comment, sorry - I only get email once for the original comment - but regarding your question on the default provider, please see PropertiesDefaultProvider in |
@Fernal73 Any further changes needed in the documentation for Boolean Options or elsewhere, or can we close this ticket? (We can always open up another one if something else comes up.) |
I've closed the issue. Parenthesising all the 'Prior to 4.0' statements would be best. |
https://picocli.info/#_boolean_options
https://picocli.info/#_toggle_boolean_flags
The section Boolean Options must specify clearly that current value toggling is supported in versions prior to 4.0 only. The behaviour becomes clearer only when the section Toggle Boolean Flags is arrived at.
Additionally, deprecated example code needs to be updated.
The text was updated successfully, but these errors were encountered: