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

Deprecated Javadoc tag should tell developers what to use instead #1121

Closed
remkop opened this issue Jun 29, 2020 · 1 comment
Closed

Deprecated Javadoc tag should tell developers what to use instead #1121

remkop opened this issue Jun 29, 2020 · 1 comment
Labels
type: API 🔌 type: doc 📘 type: enhancement ✨
Milestone
4.4

Comments

@remkop
Copy link
Owner

remkop commented Jun 29, 2020 •
edited
Loading

Methods that became deprecated in picocli 4.0 do not always explain to developers what they should use instead, as pointed out here.
@remkop remkop added this to the 4.4 milestone Jun 29, 2020
@remkop remkop added the status: invalid 😶 An issue that we don't feel is valid label Jun 30, 2020
@remkop
Copy link
Owner Author

remkop commented Jun 30, 2020 •
edited
Loading

Looking at the code, all deprecated methods already have a javadoc @deprecated tag with links to the methods that should be used instead. (Except for the addSubcommand method in CommandLine.Help.)

It is likely that the user who raised this was looking at decompiled code in their IDE, without source attached, and in this view the javadoc was hidden.

@remkop remkop closed this as completed Jun 30, 2020
remkop added a commit that referenced this issue Jun 30, 2020
@remkop
[#1121] Link to alternative in @deprecated Javadoc tag for `Help::add…
3fbc36b 
…Subcommand`
@remkop remkop removed the status: invalid 😶 An issue that we don't feel is valid label Jun 30, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: API 🔌 type: doc 📘 type: enhancement ✨
Projects
None yet
Milestone
4.4
Development

No branches or pull requests
1 participant
@remkop