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

KAFKA-12562: Fix KafkaStreams#store old references in comments #13774

Merged
merged 11 commits into from Jun 1, 2023

Conversation

milindmantri
Copy link
Contributor

Following method was deprecated in 2.5 and was removed in 3.0.0.

// KafkaStreams.java
public <T> T store(final String storeName, final QueryableStoreType<T> queryableStoreType);

However, many comments reference the removed method which can be confusing in generated JavaDocs. The code in java doc comments has been changed to reflect the new method, store(final StoreQueryParameters<T> storeQueryParameters).

Also, minor changes to variable names in java doc to be context specific.

Committer Checklist (excluded from commit message)

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

@milindmantri milindmantri force-pushed the fix-kafkastreams-store-comments branch from 9ac3e3a to 236cd8f Compare May 28, 2023 05:02
@milindmantri
Copy link
Contributor Author

Related to #10412
@guozhangwang, could you please review?

Copy link
Contributor

@cadonna cadonna left a comment

Choose a reason for hiding this comment

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

Thanks for the PR, @milindmantri!

LGTM!

@cadonna cadonna merged commit 4b46bb4 into apache:trunk Jun 1, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
3 participants