DOC: Spell out args & kwargs in tutorials.

Author: QuLogic

tutorials/intermediate/constrainedlayout_guide.py

@@ -79,7 +79,8 @@ def example_plot(ax, fontsize=12, hide_labels=False):
 # To prevent this, the location of axes needs to be adjusted. For
 # subplots, this can be done by adjusting the subplot params
 # (:ref:`howto-subplots-adjust`). However, specifying your figure with the
-# ``constrained_layout=True`` kwarg will do the adjusting automatically.
+# ``constrained_layout=True`` keyword argument will do the adjusting
+# automatically.
 
 fig, ax = plt.subplots(constrained_layout=True)
 example_plot(ax, fontsize=24)
@@ -112,7 +113,7 @@ def example_plot(ax, fontsize=12, hide_labels=False):
 #
 # .. note::
 #
-#   For the `~.axes.Axes.pcolormesh` kwargs (``pc_kwargs``) we use a
+#   For the `~.axes.Axes.pcolormesh` keyword arguments (``pc_kwargs``) we use a
 #   dictionary. Below we will assign one colorbar to a number of axes each
 #   containing a `~.cm.ScalarMappable`; specifying the norm and colormap
 #   ensures the colorbar is accurate for all the axes.

tutorials/intermediate/imshow_extent.py

@@ -2,18 +2,18 @@
 *origin* and *extent* in `~.Axes.imshow`
 ========================================
 
-:meth:`~.Axes.imshow` allows you to render an image (either a 2D array
-which will be color-mapped (based on *norm* and *cmap*) or a 3D RGB(A)
-array which will be used as-is) to a rectangular region in data space.
-The orientation of the image in the final rendering is controlled by
-the *origin* and *extent* kwargs (and attributes on the resulting
-`.AxesImage` instance) and the data limits of the axes.
-
-The *extent* kwarg controls the bounding box in data coordinates that
-the image will fill specified as ``(left, right, bottom, top)`` in
-**data coordinates**, the *origin* kwarg controls how the image fills
-that bounding box, and the orientation in the final rendered image is
-also affected by the axes limits.
+:meth:`~.Axes.imshow` allows you to render an image (either a 2D array which
+will be color-mapped (based on *norm* and *cmap*) or a 3D RGB(A) array which
+will be used as-is) to a rectangular region in data space.  The orientation of
+the image in the final rendering is controlled by the *origin* and *extent*
+keyword arguments (and attributes on the resulting `.AxesImage` instance) and
+the data limits of the axes.
+
+The *extent* keyword arguments controls the bounding box in data coordinates
+that the image will fill specified as ``(left, right, bottom, top)`` in **data
+coordinates**, the *origin* keyword argument controls how the image fills that
+bounding box, and the orientation in the final rendered image is also affected
+by the axes limits.
 
 .. hint:: Most of the code below is used for adding labels and informative
    text to the plots. The described effects of *origin* and *extent* can be

tutorials/introductory/lifecycle.py

@@ -169,14 +169,14 @@
 
 ###############################################################################
 # We can also adjust the size of this plot using the :func:`pyplot.subplots`
-# function. We can do this with the ``figsize`` kwarg.
+# function. We can do this with the *figsize* keyword argument.
 #
 # .. note::
 #
-#    While indexing in NumPy follows the form (row, column), the figsize
-#    kwarg follows the form (width, height). This follows conventions in
-#    visualization, which unfortunately are different from those of linear
-#    algebra.
+#    While indexing in NumPy follows the form (row, column), the *figsize*
+#    keyword argument follows the form (width, height). This follows
+#    conventions in visualization, which unfortunately are different from those
+#    of linear algebra.
 
 fig, ax = plt.subplots(figsize=(8, 4))
 ax.barh(group_names, group_data)
@@ -198,7 +198,7 @@
 
 
 def currency(x, pos):
-    """The two args are the value and tick position"""
+    """The two arguments are the value and tick position"""
     if x >= 1e6:
         s = '${:1.1f}M'.format(x*1e-6)
     else:

tutorials/introductory/pyplot.py

@@ -150,7 +150,7 @@
 # antialiased, etc; see `matplotlib.lines.Line2D`.  There are
 # several ways to set line properties
 #
-# * Use keyword args::
+# * Use keyword arguments::
 #
 #       plt.plot(x, y, linewidth=2.0)
 #
@@ -171,7 +171,7 @@
 #   MATLAB-style string/value pairs::
 #
 #       lines = plt.plot(x1, y1, x2, y2)
-#       # use keyword args
+#       # use keyword arguments
 #       plt.setp(lines, color='r', linewidth=2.0)
 #       # or MATLAB style string value pairs
 #       plt.setp(lines, 'color', 'r', 'linewidth', 2.0)

tutorials/introductory/usage.py

@@ -223,7 +223,7 @@ def my_plotter(ax, data1, data2, param_dict):
        The y data
 
     param_dict : dict
-       Dictionary of kwargs to pass to ax.plot
+       Dictionary of keyword arguments to pass to ax.plot
 
     Returns
     -------

tutorials/text/text_intro.py

@@ -153,7 +153,7 @@
 # *position*, via which we can manually specify the label positions.  Here we
 # put the xlabel to the far left of the axis.  Note, that the y-coordinate of
 # this position has no effect - to adjust the y-position we need to use the
-# *labelpad* kwarg.
+# *labelpad* keyword argument.
 
 fig, ax = plt.subplots(figsize=(5, 3))
 fig.subplots_adjust(bottom=0.15, left=0.2)
@@ -165,8 +165,8 @@
 
 ##############################################################################
 # All the labelling in this tutorial can be changed by manipulating the
-# `matplotlib.font_manager.FontProperties` method, or by named kwargs to
-# `~matplotlib.axes.Axes.set_xlabel`
+# `matplotlib.font_manager.FontProperties` method, or by named keyword
+# arguments to `~matplotlib.axes.Axes.set_xlabel`
 
 from matplotlib.font_manager import FontProperties
 

tutorials/text/text_props.py

@@ -213,8 +213,8 @@
 #
 #    font.sans-serif: Source Han Sans TW, Arial, sans-serif
 #
-# To control the font used on per-artist basis use the ``'name'``,
-# ``'fontname'`` or ``'fontproperties'`` kwargs documented :doc:`above
+# To control the font used on per-artist basis use the *name*, *fontname* or
+# *fontproperties* keyword arguments documented :doc:`above
 # </tutorials/text/text_props>`.
 #
 #