Skip to content

MNG-6839 Added @deprecated to documentation#330

Closed
asutosh936 wants to merge 1 commit intoapache:masterfrom
asutosh936:MNG-6839
Closed

MNG-6839 Added @deprecated to documentation#330
asutosh936 wants to merge 1 commit intoapache:masterfrom
asutosh936:MNG-6839

Conversation

@asutosh936
Copy link

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [MNG-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace MNG-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the
    commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean verify to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the Core IT successfully.

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

Copy link
Member

@michael-o michael-o left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is zero benefit in this change.

@asutosh936
Copy link
Author

I still see half glass full here. From documentation perspective there is no way to know this methods are deprecated, which will be available by this PR. As per what alternative method to use for deprecated one is still unknown to me (considering newbie contributor). We can go ahead with this PR and a related Jira should be created which provides list of alternative methods to be documented. Am ready to document those if I know what are the alternative ones to use.

@michael-o
Copy link
Member

There is already the annoation @Deprecated. The Javadoc annotation serves solely for the purporse of documenting why and what is a potential replacement.

@rfscholte
Copy link
Contributor

I agree with @michael-o , when adding deprecated doclettags, it should explain why or the new way to use it. Likely hard to provide without indepth knowledge.

@michael-o michael-o closed this Feb 24, 2020
@jira-importer
Copy link

Resolve #8623

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

Successfully merging this pull request may close these issues.

4 participants