From 53c2f8b4b6ff030b0449469e0c3fa373be8fec0f Mon Sep 17 00:00:00 2001
From: Mike McCandless <mikemccand@apache.org>
Date: Sat, 14 May 2016 13:46:34 -0400
Subject: [PATCH] improve javadocs

---
 .../java/org/elasticsearch/common/util/iterable/Iterables.java  | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/core/src/main/java/org/elasticsearch/common/util/iterable/Iterables.java b/core/src/main/java/org/elasticsearch/common/util/iterable/Iterables.java
index 4299f161874..e15328089a3 100644
--- a/core/src/main/java/org/elasticsearch/common/util/iterable/Iterables.java
+++ b/core/src/main/java/org/elasticsearch/common/util/iterable/Iterables.java
@@ -54,6 +54,8 @@ public class Iterables {
         }
     }
 
+    /** Flattens the two level {@code Iterable} into a single {@code Iterable}.  Note that this uses the original input iterable so if it
+     *  later changes, the flattened result here will reflect the change. */
     public static <T> Iterable<T> flatten(Iterable<? extends Iterable<T>> inputs) {
         Objects.requireNonNull(inputs);
         return new FlattenedIterables<>(inputs);