FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Backport PR #23607 on branch v3.6.x (DOC: document that appearance is part of our stable API) by meeseeksmachine · Pull Request #24234 · matplotlib/matplotlib · GitHub

Repository navigation

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension .rst  (2) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
3 changes: 2 additions & 1 deletion doc/devel/color_changes.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 6 additions & 0 deletions doc/devel/contributing.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

Back | FazBrowse Home | New Git URL