[kafka] branch 2.5 updated: MINOR: Improve JavaDocs in Kafka Streams (#8772)

[mj...@apache.org]

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

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


The following commit(s) were added to refs/heads/2.5 by this push:
     new 4d77e4e  MINOR: Improve JavaDocs in Kafka Streams (#8772)
4d77e4e is described below

commit 4d77e4edfa4e488e2c972dbfb1b4537ad4b79096
Author: A. Sophie Blee-Goldman <so...@confluent.io>
AuthorDate: Mon Jun 1 17:22:04 2020 -0700

    MINOR: Improve JavaDocs in Kafka Streams (#8772)
    
    Reviewers: Matthias J. Sax <ma...@confluent.io>
---
 streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java | 1 +
 1 file changed, 1 insertion(+)

diff --git a/streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java b/streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java
index 43a5341..35d6d16 100644
--- a/streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java
+++ b/streams/src/main/java/org/apache/kafka/streams/KafkaStreams.java
@@ -1225,6 +1225,7 @@ public class KafkaStreams implements AutoCloseable {
      * of invocation to once every few seconds.
      *
      * @return map of store names to another map of partition to {@link LagInfo}s
+     * @throws StreamsException if the admin client request throws exception
      */
     public Map<String, Map<Integer, LagInfo>> allLocalStorePartitionLags() {
         final long latestSentinel = -2L;