Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 2763352

Browse files
timhoffmstory645
andcommitted
DOC: Document policy on colormaps and styles
Also closes #27673 by removing that page. The relevant content is transferred to the new section. Co-authored-by: hannah <[email protected]>
1 parent 56153b9 commit 2763352

File tree

2 files changed

+18
-142
lines changed

2 files changed

+18
-142
lines changed

doc/devel/api_changes.rst

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,9 @@ if the added benefit is worth the effort of adapting existing code.
99

1010
Because we are a visualization library, our primary output is the final
1111
visualization the user sees; therefore, the appearance of the figure is part of
12-
the API and any changes, either semantic or :ref:`aesthetic <color_changes>`,
12+
the API and any changes, either semantic or aesthetic,
1313
are backwards-incompatible API changes.
1414

15-
.. toctree::
16-
:hidden:
17-
18-
color_changes.rst
19-
2015

2116
Add new API and features
2217
------------------------
@@ -37,6 +32,23 @@ take particular care when adding new API:
3732
__ https://emptysqua.re/blog/api-evolution-the-right-way/#adding-parameters
3833

3934

35+
Add or change colormaps, color sequences, and styles
36+
----------------------------------------------------
37+
Visual changes are considered an API break. Therefore, we generally do not modify
38+
existing colormaps, color sequences, or styles.
39+
40+
We put a high bar on adding new colormaps and styles to prevent excessively growing
41+
them. While decision is case-by-case, evaluation criteria include:
42+
43+
- novelty: Does it support a new use case? e.g. slight variations of existing maps,
44+
sequences and styles or yet "another divergent colormap" are likely not accepted
45+
- usability: Are colors of sequences sufficiently distinct? Has colorblindness
46+
been considered?
47+
- evidence of wide spread usage: for example academic papers, industry blogs and
48+
whitepapers, or inclusion in other visualization libraries or domain specific tools
49+
- open license: colormaps, sequences, and styles must have a BSD compatible license
50+
(see :ref:`license-discussion`)
51+
4052
.. _deprecation-guidelines:
4153

4254
Deprecate API

doc/devel/color_changes.rst

Lines changed: 0 additions & 136 deletions
This file was deleted.

0 commit comments

Comments
 (0)