Improve docs for Intersperse (palatable#54)

kschuetz · jnape · commit d3c6d297436f · 2019-06-03T18:55:51.000-05:00
diff --git a/src/main/java/com/jnape/palatable/lambda/functions/builtin/fn2/Intersperse.java b/src/main/java/com/jnape/palatable/lambda/functions/builtin/fn2/Intersperse.java
@@ -7,8 +7,8 @@
 import static com.jnape.palatable.lambda.functions.builtin.fn2.PrependAll.prependAll;
 
 /**
- * Lazily inject the provided separator value between each value in the supplied <code>Iterable</code>. An empty
- * <code>Iterable</code> is left untouched.
+ * Lazily inject the provided separator value between each value in the supplied <code>Iterable</code>. An
+ * <code>Iterable</code> with fewer than two elements is left untouched.
  *
  * @param <A> the Iterable parameter type
  * @see PrependAll
diff --git a/src/test/java/com/jnape/palatable/lambda/functions/builtin/fn2/IntersperseTest.java b/src/test/java/com/jnape/palatable/lambda/functions/builtin/fn2/IntersperseTest.java
@@ -30,6 +30,11 @@ public void interspersesBetweenElementsInIterable() {
         assertThat(intersperse(0, asList(1, 2, 3)), iterates(1, 0, 2, 0, 3));
     }
 
+    @Test
+    public void doesNotIntersperseSingletonIterable() {
+        assertThat(intersperse(0, asList(1)), iterates(1));
+    }
+
     @Test
     public void doesNotIntersperseEmptyIterable() {
         assertThat(intersperse(0, emptyList()), isEmpty());
