From ebec1361fb7cff0450ea9736e44418636fe9b869 Mon Sep 17 00:00:00 2001 From: Elliott Sales de Andrade Date: Mon, 26 Aug 2019 21:03:27 -0400 Subject: [PATCH] Backport PR #15132: Update documenting guide on rcParams --- doc/devel/documenting_mpl.rst | 11 ++--------- 1 file changed, 2 insertions(+), 9 deletions(-) diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst index 26b019af7ea7..98d2fd23ad88 100644 --- a/doc/devel/documenting_mpl.rst +++ b/doc/devel/documenting_mpl.rst @@ -500,15 +500,8 @@ section of the docstring. rcParams ~~~~~~~~ rcParams can be referenced with the custom ``:rc:`` role: -:literal:`:rc:\`foo\`` yields ``rcParams["foo"]``. Use `= [default-val]` -to indicate the default value of the parameter. The default value should be -literal, i.e. enclosed in double backticks. For simplicity these may be -omitted for string default values. - -.. code-block:: rst - - If not provided, defaults to :rc:`figure.figsize` = ``[6.4, 4.8]``. - If not provided, defaults to :rc:`figure.facecolor` = 'w'. +:literal:`:rc:\`foo\`` yields ``rcParams["foo"] = 'default'``, which is a link +to the :file:`matplotlibrc` file description. Deprecated formatting conventions ---------------------------------