Skip to content

Conversation

terakilobyte
Copy link
Member

This removes mention of geoHaystack from the docs and marks methods as deprecated.

@jyemin jyemin requested a review from rozza February 4, 2021 15:56
Copy link
Member

@rozza rozza left a comment

Choose a reason for hiding this comment

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

Looks good, only one thing, where methods are deprecated you should also add the @deprecated tag and message in the java docs

@terakilobyte
Copy link
Member Author

terakilobyte commented Feb 4, 2021

I thought I had added the @deprecated tags. Do you mean to add a quick note within the method docs it is deprecated and what to use instead?

@rozza
Copy link
Member

rozza commented Feb 4, 2021

@terakilobyte - here's an example:

* @deprecated Prefer {@link #connectionClosed} Implementations should NOT implement this method at all, instead relying on
* the default no-op implementation. If an application implements both this method and connectionClosed, the application risks
* double-counting events.
*/
@Deprecated
default void connectionRemoved(ConnectionRemovedEvent event) {

@terakilobyte
Copy link
Member Author

I've added to the method docs for the public facing methods. I was unsure if it needed to be done for the methods in internal based on driver policy.

@rozza
Copy link
Member

rozza commented Feb 5, 2021

@terakilobyte unfortunately you have to double annotate with Java once for thing being deprecated and then again in the javadoc. Scala is nicer as the annotation is combined.

I've updated the java docs and will squash and merge.

Many thanks

@rozza rozza merged commit c596a22 into mongodb:master Feb 5, 2021
jfitzu pushed a commit to nextworld-tools/mongo-java-driver that referenced this pull request Mar 3, 2021
geoHaystack was deprecated in MongoDB 4.4
jfitzu added a commit to nextworld-tools/mongo-java-driver that referenced this pull request Mar 3, 2021
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.

2 participants