Skip to content

Javadoc of code repackaged in 4.4.0 snapshots states that it has been available since earlier major versions #2010

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

Closed
wilkinsona opened this issue Nov 23, 2021 · 4 comments · Fixed by #2014
Assignees
Labels
type: task A general task

Comments

@wilkinsona
Copy link
Member

wilkinsona commented Nov 23, 2021

For example, org.springframework.data.elasticsearch.backend.elasticsearch7.client.reactive. ReactiveElasticsearchClient is documented as @since 3.2 but it's new in 5.0.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Nov 23, 2021
@sothawo
Copy link
Collaborator

sothawo commented Nov 23, 2021

It's not new, it's existing code moved to a different package. Should that change the @since?

@wilkinsona
Copy link
Member Author

wilkinsona commented Nov 23, 2021

If someone looks for org.springframework.data.elasticsearch.backend.elasticsearch7.client.reactive. ReactiveElasticsearchClient in 3.2 it won't be there, but the javadoc currently tells them that it will be. From a compatibility perspective, all of the repackaged code is new in 5.0 and I think each class's @since javadoc should reflect that.

Here's an example from Spring Boot where DispatcherServletAutoConfiguration changed package in 2.0:

Note that the @since changed from 1.0.0 to 2.0.0 as a result of the repackaging.

@sothawo
Copy link
Collaborator

sothawo commented Nov 23, 2021

ok, I'll change that to be consistent to what Spring does.

@sothawo sothawo self-assigned this Nov 23, 2021
@sothawo sothawo added type: task A general task and removed status: waiting-for-triage An issue we've not yet triaged labels Nov 23, 2021
@sothawo
Copy link
Collaborator

sothawo commented Nov 23, 2021

nitpick: the change will be from 4.4 on 😜

@sothawo sothawo changed the title Javadoc of code repackaged in 5.0 snapshots states that it has been available since earlier major versions Javadoc of code repackaged in 4.4.0 snapshots states that it has been available since earlier major versions Nov 23, 2021
sothawo added a commit to sothawo/spring-data-elasticsearch that referenced this issue Nov 23, 2021
sothawo added a commit that referenced this issue Nov 23, 2021
@sothawo sothawo added this to the 4.4 M1 (2022.0.0) milestone Nov 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: task A general task
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants