Documented breaking change in 4.3 release notes

mperry · mperry · commit b59c3d8e564a · 2015-02-09T22:03:20.000+10:00
diff --git a/etc/release-notes/release-notes-4.3.adoc b/etc/release-notes/release-notes-4.3.adoc
@@ -1,7 +1,7 @@
 
 = Release 4.3
 
-Released: Unreleased
+Released: Some future date
 
 == Enhancements
 
@@ -17,7 +17,7 @@ Released: Unreleased
 * Added equals, hashCode and toString to classes P's, Array, Either, List, Option, Seq, Set, Stream, Tree, TreeMap, Validation (#75, #86)
 * Added release notes as asciidoc (#92)
 * Added F0 interface (#93)
-* Added wrapper functions for function arity 1 and 2 (#94)
+* Added wrapper functions for function interfaces arity 1 and 2 (#94)
 * Enhanced implementation of equals for standard classes (#95)
 * Added traverse method family to P1, P2, Either, List, Validation (#80)
 * Enhanced integration with basic Java types (#99)
@@ -31,6 +31,24 @@ Released: Unreleased
 * Fixed Try javadoc (#91)
 * Fixed stack overflow in TreeMap.update (#97)
 
+== Breaking Changes
+
+* #93 added the F0 interface which P1 implements.  This could break code where the _1 method for a new P1 called the method 'f' outside P1's scope.  Making P1 implement F0 means that P1 now has an 'f' method which hides the visibility of the previously visible outer 'f'.  You can fix this by using P.lazy, as per the example below.
+
+[source,java]
+----
+// old code
+return fromString(s.some()).append(new P1<Stream<Character>>() {
+    public Stream<Character> _1() {
+        return f(reader); // call outer f, 4.3 code change breaks this
+    }
+});
+
+// new code
+return fromString(s.some()).append(P.lazy(u -> f(reader))); // outer f now visible
+----
+
+
 == Documentation
 
 * Added contributors from commit log.
