Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commite36b3c2

Browse files
timhoffmstory645
andcommitted
DOC: Document policy on colormaps and styles
Alsocloses#27673 by removing that page. The relevantcontent is transferred to the new section.Co-authored-by: hannah <story645@gmail.com>
1 parent56153b9 commite36b3c2

File tree

2 files changed

+20
-142
lines changed

2 files changed

+20
-142
lines changed

‎doc/devel/api_changes.rst

Lines changed: 20 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,25 @@ take particular care when adding new API:
3732
__https://emptysqua.re/blog/api-evolution-the-right-way/#adding-parameters
3833

3934

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

4256
Deprecate API

‎doc/devel/color_changes.rst

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

0 commit comments

Comments
 (0)

[8]ページ先頭

©2009-2025 Movatter.jp