Adding better docs for MapLens#mappingValues

jnape · jnape · commit 06131c6cf883 · 2018-05-07T22:20:58.000-05:00
diff --git a/src/main/java/com/jnape/palatable/lambda/lens/lenses/MapLens.java b/src/main/java/com/jnape/palatable/lambda/lens/lenses/MapLens.java
@@ -176,6 +176,9 @@ public static <K, V, V2> Lens.Simple<Map<K, V>, Map<K, V2>> mappingValues(Functi
 
     /**
      * A lens that focuses on a map while mapping its values with the mapping {@link Iso}.
+     * <p>
+     * Note that for this lens to be lawful, <code>iso</code> must be bijective: that is, every <code>V</code> must
+     * uniquely and invertibly map to exactly one <code>V2</code>.
      *
      * @param iso  the mapping {@link Iso}
      * @param <K>  the key type

Original file line number	Diff line number	Diff line change
`@@ -176,6 +176,9 @@ public static <K, V, V2> Lens.Simple<Map<K, V>, Map<K, V2>> mappingValues(Functi`
`176`	`176`
`177`	`177`	`/**`
`178`	`178`	`* A lens that focuses on a map while mapping its values with the mapping {@link Iso}.`
	`179`	`+ * <p>`
	`180`	`+ * Note that for this lens to be lawful, <code>iso</code> must be bijective: that is, every <code>V</code> must`
	`181`	`+ * uniquely and invertibly map to exactly one <code>V2</code>.`
`179`	`182`	`*`
`180`	`183`	`* @param iso the mapping {@link Iso}`
`181`	`184`	`* @param <K> the key type`