Skip to content

Commit f6331fb

Browse files
committed
DOC: move reproducible whats new
1 parent 4570155 commit f6331fb

File tree

1 file changed

+30
-29
lines changed

1 file changed

+30
-29
lines changed

doc/users/whats_new.rst

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,36 @@ percents, a customizable percent symbol and either automatic or manual
167167
control over the decimal points.
168168

169169

170+
Reproducible PS, PDF and SVG output
171+
-----------------------------------
172+
173+
The ``SOURCE_DATE_EPOCH`` environment variable can now be used to set
174+
the timestamp value in the PS and PDF outputs. See
175+
https://reproducible-builds.org/specs/source-date-epoch/
176+
177+
Alternatively, calling ``savefig`` with ``metadata={'creationDate': None}``
178+
will omit the timestamp altogether.
179+
180+
The reproducibility of the output from the PS and PDF backends has so
181+
far been tested using various plot elements but only default values of
182+
options such as ``{ps,pdf}.fonttype`` that can affect the output at a
183+
low level, and not with the mathtext or usetex features. When
184+
matplotlib calls external tools (such as PS distillers or LaTeX) their
185+
versions need to be kept constant for reproducibility, and they may
186+
add sources of nondeterminism outside the control of matplotlib.
187+
188+
For SVG output, the ``svg.hashsalt`` rc parameter has been added in an
189+
earlier release. This parameter changes some random identifiers in the
190+
SVG file to be deterministic. The downside of this setting is that if
191+
more than one file is generated using deterministic identifiers
192+
and they end up as parts of one larger document, the identifiers can
193+
collide and cause the different parts to affect each other.
194+
195+
These features are now enabled in the tests for the PDF and SVG
196+
backends, so most test output files (but not all of them) are now
197+
deterministic.
198+
199+
170200

171201
Improvements
172202
++++++++++++
@@ -375,35 +405,6 @@ Pending
375405

376406

377407

378-
Reproducible PS, PDF and SVG output
379-
-----------------------------------
380-
381-
The ``SOURCE_DATE_EPOCH`` environment variable can now be used to set
382-
the timestamp value in the PS and PDF outputs. See
383-
https://reproducible-builds.org/specs/source-date-epoch/
384-
385-
Alternatively, calling ``savefig`` with ``metadata={'creationDate': None}``
386-
will omit the timestamp altogether.
387-
388-
The reproducibility of the output from the PS and PDF backends has so
389-
far been tested using various plot elements but only default values of
390-
options such as ``{ps,pdf}.fonttype`` that can affect the output at a
391-
low level, and not with the mathtext or usetex features. When
392-
matplotlib calls external tools (such as PS distillers or LaTeX) their
393-
versions need to be kept constant for reproducibility, and they may
394-
add sources of nondeterminism outside the control of matplotlib.
395-
396-
For SVG output, the ``svg.hashsalt`` rc parameter has been added in an
397-
earlier release. This parameter changes some random identifiers in the
398-
SVG file to be deterministic. The downside of this setting is that if
399-
more than one file is generated using deterministic identifiers
400-
and they end up as parts of one larger document, the identifiers can
401-
collide and cause the different parts to affect each other.
402-
403-
These features are now enabled in the tests for the PDF and SVG
404-
backends, so most test output files (but not all of them) are now
405-
deterministic.
406-
407408

408409
Colormap reversed method
409410
------------------------

0 commit comments

Comments
 (0)