Fixing documentation referencing defunct TraversableIterable

jnape · jnape · commit 6312a543e2f2 · 2018-05-24T19:01:17.000-05:00
diff --git a/README.md b/README.md
@@ -444,8 +444,7 @@ Examples of traversable functors include:
 - `Choice*`
 - `Either`
 - `Const` and `Identity`
-- `TraversableIterable` for wrapping `Iterable` in an instance of `Traversable`
-- `TraversableOptional` for wrapping `Optional` in an instance of `Traversable`
+- `LambdaIterable` for wrapping `Iterable` in an instance of `Traversable`
 
 In addition to implementing `fmap` from `Functor`, implementing a traversable functor involves providing an implementation of `traverse`.
 
diff --git a/src/main/java/com/jnape/palatable/lambda/traversable/LambdaIterable.java b/src/main/java/com/jnape/palatable/lambda/traversable/LambdaIterable.java
@@ -113,21 +113,21 @@ public int hashCode() {
     }
 
     /**
-     * Wrap an {@link Iterable} in a <code>TraversableIterable</code>.
+     * Wrap an {@link Iterable} in a {@link LambdaIterable}.
      *
      * @param as  the Iterable
      * @param <A> the Iterable element type
-     * @return the Iterable wrapped in a TraversableIterable
+     * @return the Iterable wrapped in a {@link LambdaIterable}
      */
     public static <A> LambdaIterable<A> wrap(Iterable<? extends A> as) {
         return new LambdaIterable<>(as);
     }
 
     /**
-     * Construct an empty <code>TraversableIterable</code> by wrapping {@link java.util.Collections#emptyList()}.
+     * Construct an empty {@link LambdaIterable} by wrapping {@link java.util.Collections#emptyList()}.
      *
      * @param <A> the Iterable element type
-     * @return a TraversableIterable wrapping Collections.emptyList()
+     * @return a {@link LambdaIterable} wrapping Collections.emptyList()
      */
     public static <A> LambdaIterable<A> empty() {
         return wrap(emptyList());

Original file line number	Diff line number	Diff line change
`@@ -113,21 +113,21 @@ public int hashCode() {`
`113`	`113`	`}`
`114`	`114`
`115`	`115`	`/**`
`116`		`- * Wrap an {@link Iterable} in a <code>TraversableIterable</code>.`
	`116`	`+ * Wrap an {@link Iterable} in a {@link LambdaIterable}.`
`117`	`117`	`*`
`118`	`118`	`* @param as the Iterable`
`119`	`119`	`* @param <A> the Iterable element type`
`120`		`- * @return the Iterable wrapped in a TraversableIterable`
	`120`	`+ * @return the Iterable wrapped in a {@link LambdaIterable}`
`121`	`121`	`*/`
`122`	`122`	`public static <A> LambdaIterable<A> wrap(Iterable<? extends A> as) {`
`123`	`123`	`return new LambdaIterable<>(as);`
`124`	`124`	`}`
`125`	`125`
`126`	`126`	`/**`
`127`		`- * Construct an empty <code>TraversableIterable</code> by wrapping {@link java.util.Collections#emptyList()}.`
	`127`	`+ * Construct an empty {@link LambdaIterable} by wrapping {@link java.util.Collections#emptyList()}.`
`128`	`128`	`*`
`129`	`129`	`* @param <A> the Iterable element type`
`130`		`- * @return a TraversableIterable wrapping Collections.emptyList()`
	`130`	`+ * @return a {@link LambdaIterable} wrapping Collections.emptyList()`
`131`	`131`	`*/`
`132`	`132`	`public static <A> LambdaIterable<A> empty() {`
`133`	`133`	`return wrap(emptyList());`