diff --git a/ultraplot/axes/base.py b/ultraplot/axes/base.py index dba968bff..bc8b3d718 100644 --- a/ultraplot/axes/base.py +++ b/ultraplot/axes/base.py @@ -317,9 +317,9 @@ The axes title. Can optionally be a sequence strings, in which case the title will be selected from the sequence according to `~Axes.number`. abc : bool or str or sequence, default: :rc:`abc` - The "a-b-c" subplot label style. Must contain the character ``a`` or ``A``, + The "a-b-c" subplot label style. Must contain the character `a` or `A`, for example ``'a.'``, or ``'A'``. If ``True`` then the default style of - ``'a'`` is used. The ``a`` or ``A`` is replaced with the alphabetic character + ``'a'`` is used. The `a` or ``A`` is replaced with the alphabetic character matching the `~Axes.number`. If `~Axes.number` is greater than 26, the characters loop around to a, ..., z, aa, ..., zz, aaa, ..., zzz, etc. Can also be a sequence of strings, in which case the "a-b-c" label will be selected sequentially from the list. For example `axs.format(abc = ["X", "Y"])` for a two-panel figure, and `axes[3:5].format(abc = ["X", "Y"])` for a two-panel subset of a larger figure. @@ -341,8 +341,8 @@ upper left inside axes ``'upper left'``, ``'ul'`` lower left inside axes ``'lower left'``, ``'ll'`` lower right inside axes ``'lower right'``, ``'lr'`` - left of y axis ```'outer left'``, ``'ol'`` - right of y axis ```'outer right'``, ``'or'`` + left of y axis ``'outer left'``, ``'ol'`` + right of y axis ``'outer right'``, ``'or'`` ======================== ============================ abcborder, titleborder : bool, default: :rc:`abc.border` and :rc:`title.border` @@ -370,16 +370,15 @@ abctitlepad : float, default: :rc:`abc.titlepad` The horizontal padding between a-b-c labels and titles in the same location. %(units.pt)s -ltitle, ctitle, rtitle, ultitle, uctitle, urtitle, lltitle, lctitle, lrtitle \\ -: str or sequence, optional +ltitle, ctitle, rtitle, ultitle, uctitle, urtitle, lltitle, lctitle, lrtitle : str or sequence, optional \\ Shorthands for the below keywords. -lefttitle, centertitle, righttitle, upperlefttitle, uppercentertitle, upperrighttitle, \\ + lefttitle, centertitle, righttitle, upperlefttitle, uppercentertitle, upperrighttitle : str or sequence, optional lowerlefttitle, lowercentertitle, lowerrighttitle : str or sequence, optional Additional titles in specific positions (see `title` for details). This works as an alternative to the ``ax.format(title='Title', titleloc=loc)`` workflow and permits adding more than one title-like label for a single axes. -a, alpha, fc, facecolor, ec, edgecolor, lw, linewidth, ls, linestyle : default: \\ -:rc:`axes.alpha`, :rc:`axes.facecolor`, :rc:`axes.edgecolor`, :rc:`axes.linewidth`, '-' +a, alpha, fc, facecolor, ec, edgecolor, lw, linewidth, ls, linestyle : default: + :rc:`axes.alpha` (default: 1.0), :rc:`axes.facecolor` (default: white), :rc:`axes.edgecolor` (default: black), :rc:`axes.linewidth` (default: 0.6), - Additional settings applied to the background patch, and their shorthands. Their defaults values are the ``'axes'`` properties. """ @@ -3646,7 +3645,7 @@ def colorbar(self, mappable, values=None, loc=None, location=None, **kwargs): width or height (default is :rcraw:`colorbar.length`). For inset colorbars, floats interpreted as em-widths and strings interpreted by `~ultraplot.utils.units` (default is :rcraw:`colorbar.insetlength`). - width : unit-spec, default: :rc:`colorbar.width` or :rc:`colorbar.insetwidth + width : unit-spec, default: :rc:`colorbar.width` or :rc:`colorbar.insetwidth` The colorbar width. For outer colorbars, floats are interpreted as inches (default is :rcraw:`colorbar.width`). For inset colorbars, floats are interpreted as em-widths (default is :rcraw:`colorbar.insetwidth`). diff --git a/ultraplot/axes/geo.py b/ultraplot/axes/geo.py index f08bc48cf..e0541a6b1 100644 --- a/ultraplot/axes/geo.py +++ b/ultraplot/axes/geo.py @@ -210,7 +210,7 @@ must be passed to `~ultraplot.constructor.Proj` instead. color : color-spec, default: :rc:`meta.color` The color for the axes edge. Propagates to `labelcolor` unless specified - otherwise (similar to :func:`ultraplot.axes.CartesianAxes.format`). + otherwise (similar to :func:`~ultraplot.axes.CartesianAxes.format`). gridcolor : color-spec, default: :rc:`grid.color` The color for the gridline labels. labelcolor : color-spec, default: `color` or :rc:`grid.labelcolor` diff --git a/ultraplot/axes/plot.py b/ultraplot/axes/plot.py index 526e6ffac..f576a468b 100644 --- a/ultraplot/axes/plot.py +++ b/ultraplot/axes/plot.py @@ -951,7 +951,7 @@ **kwargs Passed to `~matplotlib.axes.Axes.scatter`. -See for more info on the grouping behavior :func:`~ultraplot.PlotAxes.bar`, and for formatting :func:~ultraplot.PlotAxes.scatter`. +See for more info on the grouping behavior :func:`~ultraplot.PlotAxes.bar`, and for formatting :func:`~ultraplot.PlotAxes.scatter`. Returns ------- List of ~matplotlib.collections.PatchCollection, and a ~matplotlib.collections.LineCollection @@ -1282,8 +1282,8 @@ Parameters ---------- g : networkx.Graph - The graph object to be plotted. Can be any subclass of :class:`networkx.Graph`, such as - :class:`networkx.DiGraph` or :class:`networkx.MultiGraph`. + The graph object to be plotted. Can be any subclass of :class:`~networkx.Graph`, such as + :class:`~networkx.DiGraph` or :class:`~networkx.MultiGraph`. layout : callable or dict, optional A layout function or a precomputed dict mapping nodes to 2D positions. If a function is given, it is called as ``layout(g, **layout_kw)`` to compute positions. See :func:`networkx.drawing.nx_pylab.draw` for more information. diff --git a/ultraplot/axes/polar.py b/ultraplot/axes/polar.py index 94950179d..24f72e8c9 100644 --- a/ultraplot/axes/polar.py +++ b/ultraplot/axes/polar.py @@ -83,7 +83,7 @@ `~ultraplot.constructor.Formatter`. color : color-spec, default: :rc:`meta.color` Color for the axes edge. Propagates to `labelcolor` unless specified - otherwise (similar to :func:`ultraplot.axes.CartesianAxes.format`). + otherwise (similar to :func:`~ultraplot.axes.CartesianAxes.format`). labelcolor, gridlabelcolor : color-spec, default: `color` or :rc:`grid.labelcolor` Color for the gridline labels. labelpad, gridlabelpad : unit-spec, default: :rc:`grid.labelpad` diff --git a/ultraplot/colors.py b/ultraplot/colors.py index e8601c8d7..2f8d5fc6e 100644 --- a/ultraplot/colors.py +++ b/ultraplot/colors.py @@ -584,7 +584,7 @@ def _make_lookup_table(N, data, gamma=1.0, inverse=False): y = y_{1,i} + w_i^{\gamma_i}*(y_{0,i+1} - y_{1,i}) where `\gamma_i` corresponds to `gamma` and the weight `w_i` ranges from - 0 to 1 between rows ``i`` and ``i+1``. If `gamma` is float, it applies + 0 to 1 between rows `i` and ``i+1``. If `gamma` is float, it applies to every transition. Otherwise, its length must equal ``data.shape[0]-1``. This is similar to the `matplotlib.colors.makeMappingArray` `gamma` except @@ -3057,7 +3057,7 @@ def __getitem__(self, key): The number is the color list index. This works everywhere that colors are used in matplotlib, for - example as `color`, `edgecolor', or `facecolor` keyword arguments + example as `color`, `edgecolor`, or `facecolor` keyword arguments passed to :class:`~ultraplot.axes.PlotAxes` commands. """ key = self._parse_key(key) diff --git a/ultraplot/figure.py b/ultraplot/figure.py index 5d302f318..e70ea896a 100644 --- a/ultraplot/figure.py +++ b/ultraplot/figure.py @@ -313,7 +313,7 @@ The axes number used for a-b-c labeling. See `~ultraplot.axes.Axes.format` for details. By default this is incremented automatically based on the other subplots in the figure. Use e.g. ``number=None`` or ``number=False`` to ensure the subplot - has no a-b-c label. Note the number corresponding to ``a`` is ``1``, not ``0``. + has no a-b-c label. Note the number corresponding to `a` is ``1``, not ``0``. autoshare : bool, default: True Whether to automatically share the *x* and *y* axes with subplots spanning the same rows and columns based on the figure-wide `sharex` and `sharey` settings. diff --git a/ultraplot/internals/rcsetup.py b/ultraplot/internals/rcsetup.py index 7439f35cf..da308a769 100644 --- a/ultraplot/internals/rcsetup.py +++ b/ultraplot/internals/rcsetup.py @@ -943,8 +943,8 @@ def copy(self): False, _validate_abc, "If ``False`` then a-b-c labels are disabled. If ``True`` the default label " - "style ``a`` is used. If string this indicates the style and must contain the " - "character ``a`` or ``A``, for example ``'a.'`` or ``'(A)'``.", + "style `a` is used. If string this indicates the style and must contain the " + "character `a` or ``A``, for example ``'a.'`` or ``'(A)'``.", ), "abc.border": ( True, diff --git a/ultraplot/scale.py b/ultraplot/scale.py index 8fc2a05b8..84ba7d14c 100644 --- a/ultraplot/scale.py +++ b/ultraplot/scale.py @@ -36,7 +36,7 @@ def _parse_logscale_args(*keys, **kwargs): """ Parse arguments for `LogScale` and `SymmetricalLogScale` that - inexplicably require ``x`` and ``y`` suffixes by default. Also + inexplicably require `x` and `y` suffixes by default. Also change the default `linthresh` to ``1``. """ # NOTE: Scale classes ignore unused arguments with warnings, but matplotlib 3.3 @@ -186,7 +186,7 @@ def __init__(self, **kwargs): class LogScale(_Scale, mscale.LogScale): """ As with `~matplotlib.scale.LogScale` but with `~ultraplot.ticker.AutoFormatter` - as the default major formatter. ``x`` and ``y`` versions of each keyword + as the default major formatter. `x` and `y` versions of each keyword argument are no longer required. """ @@ -224,7 +224,7 @@ class SymmetricalLogScale(_Scale, mscale.SymmetricalLogScale): """ As with `~matplotlib.scale.SymmetricalLogScale` but with `~ultraplot.ticker.AutoFormatter` as the default major formatter. - ``x`` and ``y`` versions of each keyword argument are no longer + `x` and `y` versions of each keyword argument are no longer required. """