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

Skip to content

Commit df33d71

Browse files
committed
Update documenting description on rcParams
1 parent 8df7fe1 commit df33d71

File tree

1 file changed

+2
-9
lines changed

1 file changed

+2
-9
lines changed

doc/devel/documenting_mpl.rst

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -511,15 +511,8 @@ section of the docstring.
511511
rcParams
512512
~~~~~~~~
513513
rcParams can be referenced with the custom ``:rc:`` role:
514-
:literal:`:rc:\`foo\`` yields ``rcParams["foo"]``. Use `= [default-val]`
515-
to indicate the default value of the parameter. The default value should be
516-
literal, i.e. enclosed in double backticks. For simplicity these may be
517-
omitted for string default values.
518-
519-
.. code-block:: rst
520-
521-
If not provided, defaults to :rc:`figure.figsize` = ``[6.4, 4.8]``.
522-
If not provided, defaults to :rc:`figure.facecolor` = 'w'.
514+
:literal:`:rc:\`foo\`` yields ``rcParams["foo"] = 'default'``, which is a link
515+
to the :file:`matplotlibrc` file description.
523516

524517
Deprecated formatting conventions
525518
---------------------------------

0 commit comments

Comments
 (0)