Cleanup some references to rcParams in docs. (#15801)

anntzer · web-flow · commit d7c40ae7f9f3 · 2019-12-01T19:00:35.000+01:00
Cleanup some references to rcParams in docs.
diff --git a/doc/faq/howto_faq.rst b/doc/faq/howto_faq.rst
@@ -103,7 +103,7 @@ off on a per-axis basis::
 
    ax.get_xaxis().get_major_formatter().set_useOffset(False)
 
-set the rcParam ``axes.formatter.useoffset``, or use a different
+set :rc:`axes.formatter.useoffset`, or use a different
 formatter.  See :mod:`~matplotlib.ticker` for details.
 
 .. _howto-transparent:
diff --git a/doc/users/dflt_style_changes.rst b/doc/users/dflt_style_changes.rst
@@ -276,7 +276,7 @@ The following changes were made to the default behavior of
 `~matplotlib.axes.Axes.scatter`
 
 - The default size of the elements in a scatter plot is now based on
-  the rcParam ``lines.markersize`` so it is consistent with ``plot(X,
+  :rc:`lines.markersize` so it is consistent with ``plot(X,
   Y, 'o')``.  The old value was 20, and the new value is 36 (6^2).
 - Scatter markers no longer have a black edge.
 - If the color of the markers is not specified it will follow the
@@ -643,7 +643,7 @@ Hatching
 The color of the lines in the hatch is now determined by
 
 - If an edge color is explicitly set, use that for the hatch color
-- If the edge color is not explicitly set, use ``rcParam['hatch.color']`` which
+- If the edge color is not explicitly set, use :rc:`hatch.color` which
   is looked up at artist creation time.
 
 The width of the lines in a hatch pattern is now configurable by the
@@ -948,8 +948,8 @@ sets the view limits to 5% wider than the data range.
 
 The size of the padding in the x and y directions is controlled by the
 ``'axes.xmargin'`` and ``'axes.ymargin'`` rcParams respectively. Whether
-the view limits should be 'round numbers' is controlled by the
-``'axes.autolimit_mode'`` rcParam.  In the original ``'round_number'`` mode,
+the view limits should be 'round numbers' is controlled by
+:rc:`axes.autolimit_mode`.  In the original ``'round_number'`` mode,
 the view limits coincide with ticks.
 
 The previous default can be restored by using::
@@ -1132,7 +1132,7 @@ but cannot be controlled independently via ``rcParams``.
 
 With the default of ``rcParams['axes.formatter.useoffset'] = True``,
 an offset will be used when it will save 4 or more digits.  This can
-be controlled with the new rcParam, ``axes.formatter.offset_threshold``.
+be controlled with the new :rc:`axes.formatter.offset_threshold`.
 To restore the previous behavior of using an offset to save 2 or more
 digits, use ``rcParams['axes.formatter.offset_threshold'] = 2``.
 
diff --git a/lib/matplotlib/backend_bases.py b/lib/matplotlib/backend_bases.py
@@ -2125,8 +2125,8 @@ def print_figure(self, filename, dpi=None, facecolor=None, edgecolor=None,
     @classmethod
     def get_default_filetype(cls):
         """
-        Get the default savefig file format as specified in rcParam
-        ``savefig.format``. Returned string excludes period. Overridden
+        Get the default savefig file format as specified in
+        :rc:`savefig.format`. Returned string excludes period. Overridden
         in backends that only support a single file type.
         """
         return rcParams['savefig.format']
diff --git a/lib/matplotlib/ticker.py b/lib/matplotlib/ticker.py
@@ -23,7 +23,7 @@
 
    ax.get_xaxis().get_major_formatter().set_useOffset(False)
 
-set the rcParam ``axes.formatter.useoffset=False`` to turn it off
+Set :rc:`axes.formatter.useoffset` to turn it off
 globally, or set a different formatter.
 
 Tick locating
diff --git a/tutorials/text/mathtext.py b/tutorials/text/mathtext.py
@@ -51,9 +51,8 @@
      # $ % & ~ _ ^ \ { } \( \) \[ \]
 
    have special meaning outside of math mode in TeX.  Therefore, these
-   characters will behave differently depending on the rcParam ``text.usetex``
-   flag.  See the :doc:`usetex tutorial </tutorials/text/usetex>` for more
-   information.
+   characters will behave differently depending on :rc:`text.usetex`.  See the
+   :doc:`usetex tutorial </tutorials/text/usetex>` for more information.
 
 Subscripts and superscripts
 ---------------------------
@@ -159,7 +158,7 @@
 
 .. note::
 
-   This default can be changed using the ``mathtext.default`` rcParam.  This is
+   This default can be changed using :rc:`mathtext.default`.  This is
    useful, for example, to use the same font as regular non-math text for math
    text, by setting it to ``regular``.
 
@@ -274,7 +273,7 @@
 
 mathtext also provides a way to use custom fonts for math.  This method is
 fairly tricky to use, and should be considered an experimental feature for
-patient users only.  By setting the rcParam ``mathtext.fontset`` to ``custom``,
+patient users only.  By setting :rc:`mathtext.fontset` to ``custom``,
 you can then set the following parameters, which control which font file to use
 for a particular set of math characters.
 
@@ -296,8 +295,8 @@
 
 The fonts used should have a Unicode mapping in order to find any
 non-Latin characters, such as Greek.  If you want to use a math symbol
-that is not contained in your custom fonts, you can set the rcParam
-``mathtext.fallback_to_cm`` to ``True`` which will cause the mathtext system
+that is not contained in your custom fonts, you can set
+:rc:`mathtext.fallback_to_cm` to ``True`` which will cause the mathtext system
 to use characters from the default Computer Modern fonts whenever a particular
 character can not be found in the custom font.
 
diff --git a/tutorials/text/usetex.py b/tutorials/text/usetex.py
@@ -70,7 +70,7 @@
      # $ % & ~ _ ^ \ { } \( \) \[ \]
 
    Therefore, these characters will behave differently depending on
-   the rcParam ``text.usetex`` flag.
+   :rc:`text.usetex`.
 
 .. _usetex-unicode:
 
