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

Example code in documentation does not compile #591

Open
hogejo opened this issue Nov 29, 2024 · 1 comment
Open

Example code in documentation does not compile #591

hogejo opened this issue Nov 29, 2024 · 1 comment

Comments

@hogejo
Copy link
Contributor

hogejo commented Nov 29, 2024

I keep bumping into example code that does not compile. 🥲

I have the following problems:

  1. Example classes should be either package private or public - for consistence
    https://jcommander.org/#_parameter_delegates has package private classes, while https://jcommander.org/#_more_complex_syntaxes_commands has public and private at the same time
  2. Example classes should never be private
    Is https://jcommander.org/#_internationalization or any example with a private class correct?
  3. Class members should be also package private or public - for consistence
    For example, https://jcommander.org/#_parameter_delegates won't work with private members

I would like to fix all of the above, but I would like a decision from the maintainers please!

Since these classes and members are used for configuration or applications, I would assume most of us put them in a dedicated package and make the classes and members public. So I would default to public classes and members. Let me know if I can fix all classes and members like that.

Thank you for the library,
Greg

@mkarg
Copy link
Collaborator

mkarg commented Dec 11, 2024

I would kindly ask for only changing the absolute essential minimum change, and to abstain from any non-essential refactoring. Having said that, what actually is not compiling?

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