API/DOC: add documentation for new exceptions

tacaswell · tacaswell · commit a9cad4ac5fae · 2016-01-03T15:26:08.000-05:00
diff --git a/doc/api/api_changes/2016-01-03_colorbar.rst b/doc/api/api_changes/2016-01-03_colorbar.rst
@@ -0,0 +1,12 @@
+`ColorBar` raises TypeError rather than ignore user input
+`````````````````````````````````````````````````````````
+
+In ``__init__`` `ColorBar` ignores user supplied ``cmap`` and ``norm``
+keyword arguments in favor of retrieving those values from the
+``mappable`` passed in.  If those keywords are supplied `ColorBar`
+will now raise a `TypeError` rather than silently drop user supplied
+input.
+
+If ``mappable`` is a `contouer.ContourSet` then a `TypeError` will be raised
+if the user provides any of
+``('alpha', 'boundaries', 'values', 'extend', 'ticks', 'filled')``
