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

Commitc56c404

Browse files
authored
Merge pull request#28815 from timhoffm/doc-new-colormaps
DOC: Document policy on colormaps and styles
2 parents64d45cb +06d5c27 commitc56c404

File tree

2 files changed

+19
-143
lines changed

2 files changed

+19
-143
lines changed

‎doc/devel/api_changes.rst

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,8 @@ 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>`,
13-
are backwards-incompatible API changes.
14-
15-
..toctree::
16-
:hidden:
17-
18-
color_changes.rst
12+
the API and any changes, either semantic or aesthetic, are backwards-incompatible
13+
API changes.
1914

2015

2116
Add new API and features
@@ -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 the 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 are likely not accepted.
45+
- usability and accessibility: Are colors of sequences sufficiently distinct? Has
46+
colorblindness 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)

[8]ページ先頭

©2009-2025 Movatter.jp