From df33d71b4e7aa05deb8a6ce0e63e4c60f301c335 Mon Sep 17 00:00:00 2001 From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com> Date: Mon, 26 Aug 2019 21:10:39 +0200 Subject: [PATCH] Update documenting description 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 11bc9bb40586..b8d27412e300 100644 --- a/doc/devel/documenting_mpl.rst +++ b/doc/devel/documenting_mpl.rst @@ -511,15 +511,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 ---------------------------------