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

Documentation is inconsistent. #867

Closed
linusjf opened this issue Nov 16, 2019 · 6 comments
Closed

Documentation is inconsistent. #867

linusjf opened this issue Nov 16, 2019 · 6 comments
Milestone

Comments

@linusjf
Copy link

linusjf commented Nov 16, 2019

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.

@remkop
Copy link
Owner

remkop commented Nov 16, 2019

Thanks for pointing this out. I’ll improve the docs. Can you point me to specific deprecated examples?

remkop added a commit that referenced this issue Nov 16, 2019
@remkop
Copy link
Owner

remkop commented Nov 16, 2019

I updated the Boolean Options section of the user manual. Is this sufficient? (Also please let me know which deprecated example code needs updating.)

@remkop remkop added this to the 4.1 milestone Nov 16, 2019
@linusjf
Copy link
Author

linusjf commented Nov 16, 2019 via email

remkop added a commit that referenced this issue Nov 17, 2019
@remkop
Copy link
Owner

remkop commented Nov 17, 2019

@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 picocli-examples. (I know this duplicates our other thread in the #542 ticket, but I did not want to leave your question unanswered here - we can discuss further in #542)).

@remkop
Copy link
Owner

remkop commented Nov 18, 2019

@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.)

@linusjf linusjf closed this as completed Nov 18, 2019
@linusjf
Copy link
Author

linusjf commented Nov 18, 2019

I've closed the issue. Parenthesising all the 'Prior to 4.0' statements would be best.

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

No branches or pull requests

2 participants