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

Skip to content

Commit 9731438

Browse files
committed
DOC: hove rcParams validation whats new
1 parent bf6f801 commit 9731438

1 file changed

Lines changed: 32 additions & 32 deletions

File tree

doc/users/whats_new.rst

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -484,6 +484,38 @@ the API required by a class that is to be used as the ``writer`` in the
484484
:class:`~matplotlib.animation.MovieWriter` class now derives from the new
485485
abstract base class.
486486

487+
Validation of line style rcParams
488+
---------------------------------
489+
490+
Stricter validation
491+
~~~~~~~~~~~~~~~~~~~
492+
The validation of rcParams that are related to line styles
493+
(``lines.linestyle``, ``boxplot.*.linestyle``, ``grid.linestyle`` and
494+
``contour.negative_linestyle``) now effectively checks that the values
495+
are valid line styles. Strings like ``dashed`` or ``--`` are accepted,
496+
as well as even-length sequences of on-off ink like ``[1, 1.65]``. In
497+
this latter case, the offset value is handled internally and should *not*
498+
be provided by the user.
499+
500+
The validation is case-insensitive.
501+
502+
Deprecation of the former validators for ``contour.negative_linestyle``
503+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
504+
The new validation scheme replaces the former one used for the
505+
``contour.negative_linestyle`` rcParams, that was limited to ``solid``
506+
and ``dashed`` line styles.
507+
508+
The former public validation functions ``validate_negative_linestyle``
509+
and ``validate_negative_linestyle_legacy`` will be deprecated in 2.1 and
510+
may be removed in 2.3. There are no public functions to replace them.
511+
512+
Examples of use
513+
~~~~~~~~~~~~~~~
514+
::
515+
516+
grid.linestyle : (1, 3) # loosely dotted grid lines
517+
contour.negative_linestyle : dashdot # previously only solid or dashed
518+
487519

488520
Performance
489521
+++++++++++
@@ -519,38 +551,6 @@ values are unlikely to cause any visible differences in your plots.
519551
Pending
520552
+++++++
521553

522-
Validation of line style rcParams
523-
---------------------------------
524-
525-
Stricter validation
526-
~~~~~~~~~~~~~~~~~~~
527-
The validation of rcParams that are related to line styles
528-
(``lines.linestyle``, ``boxplot.*.linestyle``, ``grid.linestyle`` and
529-
``contour.negative_linestyle``) now effectively checks that the values
530-
are valid line styles. Strings like ``dashed`` or ``--`` are accepted,
531-
as well as even-length sequences of on-off ink like ``[1, 1.65]``. In
532-
this latter case, the offset value is handled internally and should *not*
533-
be provided by the user.
534-
535-
The validation is case-insensitive.
536-
537-
Deprecation of the former validators for ``contour.negative_linestyle``
538-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
539-
The new validation scheme replaces the former one used for the
540-
``contour.negative_linestyle`` rcParams, that was limited to ``solid``
541-
and ``dashed`` line styles.
542-
543-
The former public validation functions ``validate_negative_linestyle``
544-
and ``validate_negative_linestyle_legacy`` will be deprecated in 2.1 and
545-
may be removed in 2.3. There are no public functions to replace them.
546-
547-
Examples of use
548-
~~~~~~~~~~~~~~~
549-
::
550-
551-
grid.linestyle : (1, 3) # loosely dotted grid lines
552-
contour.negative_linestyle : dashdot # previously only solid or dashed
553-
554554

555555
New keyword argument 'sep' for EngFormatter
556556
-------------------------------------------

0 commit comments

Comments
 (0)