(kafka) branch trunk updated: MINOR: Adjust javadoc to reflect the correct status of standby task TopicPartition (#18892)

[bbejeck]

This is an automated email from the ASF dual-hosted git repository.

bbejeck pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/kafka.git


The following commit(s) were added to refs/heads/trunk by this push:
     new 3aae6f5402e MINOR: Adjust javadoc to reflect the correct status of 
standby task TopicPartition (#18892)
3aae6f5402e is described below

commit 3aae6f5402e01aedc460326be83cc4250c39c04b
Author: Bill Bejeck <bbej...@apache.org>
AuthorDate: Thu Feb 13 14:06:01 2025 -0500

    MINOR: Adjust javadoc to reflect the correct status of standby task 
TopicPartition (#18892)
    
    KIP-744 introduced the StreamsMetadata class as part of the implementation. 
In the KIP, the javadoc for the standbyTopicPartitions states that the method 
returns the set of source TopicPartition that it represents as a standby. The 
current javadoc states that it represents the changelog TopicPartition(s). 
While the partitions of the source and changelog topics will match, the javadoc 
needs to be updated to reflect the correct behavior.
    
    Note that the deprecated 
o.a.k.streams.state.StreamsMetadata#standbyTopicPartitions method also 
describes the set of TopicPartition being source TopicPartition.
    
    Reviewers: Matthias Sax<mj...@apache.org>
---
 streams/src/main/java/org/apache/kafka/streams/StreamsMetadata.java | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git 
a/streams/src/main/java/org/apache/kafka/streams/StreamsMetadata.java 
b/streams/src/main/java/org/apache/kafka/streams/StreamsMetadata.java
index 4af0f614a1b..c751325f942 100644
--- a/streams/src/main/java/org/apache/kafka/streams/StreamsMetadata.java
+++ b/streams/src/main/java/org/apache/kafka/streams/StreamsMetadata.java
@@ -49,9 +49,9 @@ public interface StreamsMetadata {
     Set<TopicPartition> topicPartitions();
 
     /**
-     * Changelog topic partitions for the state stores the standby tasks of 
the Streams client replicates.
+     * Source topic partitions for which the instance acts as standby.
      *
-     * @return set of changelog topic partitions of the standby tasks
+     * @return source topic partitions of the standby tasks
      */
     Set<TopicPartition> standbyTopicPartitions();