Merge pull request #23607 from tacaswell/doc_apperance_is_api

tacaswell · web-flow · commit 2d18bba0ea0e · 2022-10-20T18:44:37.000-04:00
DOC: document that appearance is part of our stable API
diff --git a/doc/devel/color_changes.rst b/doc/devel/color_changes.rst
@@ -4,7 +4,8 @@
 Default color changes
 *********************
 
-As discussed at length elsewhere [insert links], ``jet`` is an
+As discussed at length `elsewhere <https://bids.github.io/colormap/>`__ ,
+``jet`` is an
 empirically bad colormap and should not be the default colormap.
 Due to the position that changing the appearance of the plot breaks
 backward compatibility, this change has been put off for far longer
diff --git a/doc/devel/contributing.rst b/doc/devel/contributing.rst
@@ -331,6 +331,12 @@ API consistency and stability are of great value. Therefore, API changes
 (e.g. signature changes, behavior changes, removals) will only be conducted
 if the added benefit is worth the user effort for adapting.
 
+Because we are a visualization library our primary output is the final
+visualization the user sees.  Thus it is our :ref:`long standing
+<color_changes>` policy that the appearance of the figure is part of the API
+and any changes, either semantic or esthetic, will be treated as a
+backwards-incompatible API change.
+
 API changes in Matplotlib have to be performed following the deprecation process
 below, except in very rare circumstances as deemed necessary by the development team.
 This ensures that users are notified before the change will take effect and thus
