Skip to content

Commit 70ba5e1

Browse files
committed
Fix formatting of :rc: role in axes/base.py docstrings
Removes the leading hyphen from the :rc: entry which was causing incorrect rendering. Also includes other docstring fixes and updates present in the working directory.
1 parent d31f165 commit 70ba5e1

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

ultraplot/axes/base.py

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -317,9 +317,9 @@
317317
The axes title. Can optionally be a sequence strings, in which case
318318
the title will be selected from the sequence according to `~Axes.number`.
319319
abc : bool or str or sequence, default: :rc:`abc`
320-
The "a-b-c" subplot label style. Must contain the character ``a`` or ``A``,
320+
The "a-b-c" subplot label style. Must contain the character `a` or ``A``,
321321
for example ``'a.'``, or ``'A'``. If ``True`` then the default style of
322-
``'a'`` is used. The ``a`` or ``A`` is replaced with the alphabetic character
322+
``'a'`` is used. The `a` or ``A`` is replaced with the alphabetic character
323323
matching the `~Axes.number`. If `~Axes.number` is greater than 26, the
324324
characters loop around to a, ..., z, aa, ..., zz, aaa, ..., zzz, etc.
325325
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 @@
341341
upper left inside axes ``'upper left'``, ``'ul'``
342342
lower left inside axes ``'lower left'``, ``'ll'``
343343
lower right inside axes ``'lower right'``, ``'lr'``
344-
left of y axis ```'outer left'``, ``'ol'``
345-
right of y axis ```'outer right'``, ``'or'``
344+
left of y axis ``'outer left'``, ``'ol'``
345+
right of y axis ``'outer right'``, ``'or'``
346346
======================== ============================
347347
348348
abcborder, titleborder : bool, default: :rc:`abc.border` and :rc:`title.border`
@@ -370,16 +370,15 @@
370370
abctitlepad : float, default: :rc:`abc.titlepad`
371371
The horizontal padding between a-b-c labels and titles in the same location.
372372
%(units.pt)s
373-
ltitle, ctitle, rtitle, ultitle, uctitle, urtitle, lltitle, lctitle, lrtitle \\
374-
: str or sequence, optional
373+
ltitle, ctitle, rtitle, ultitle, uctitle, urtitle, lltitle, lctitle, lrtitle : str or sequence, optional \\
375374
Shorthands for the below keywords.
376-
lefttitle, centertitle, righttitle, upperlefttitle, uppercentertitle, upperrighttitle, \\
375+
lefttitle, centertitle, righttitle, upperlefttitle, uppercentertitle, upperrighttitle : str or sequence, optional
377376
lowerlefttitle, lowercentertitle, lowerrighttitle : str or sequence, optional
378377
Additional titles in specific positions (see `title` for details). This works as
379378
an alternative to the ``ax.format(title='Title', titleloc=loc)`` workflow and
380379
permits adding more than one title-like label for a single axes.
381380
a, alpha, fc, facecolor, ec, edgecolor, lw, linewidth, ls, linestyle : default: \\
382-
:rc:`axes.alpha`, :rc:`axes.facecolor`, :rc:`axes.edgecolor`, :rc:`axes.linewidth`, '-'
381+
:rc:`axes.alpha` (default: 1.0), :rc:`axes.facecolor` (default: white), :rc:`axes.edgecolor` (default: black), :rc:`axes.linewidth` (default: 0.6), -
383382
Additional settings applied to the background patch, and their
384383
shorthands. Their defaults values are the ``'axes'`` properties.
385384
"""
@@ -3646,7 +3645,7 @@ def colorbar(self, mappable, values=None, loc=None, location=None, **kwargs):
36463645
width or height (default is :rcraw:`colorbar.length`). For inset
36473646
colorbars, floats interpreted as em-widths and strings interpreted
36483647
by `~ultraplot.utils.units` (default is :rcraw:`colorbar.insetlength`).
3649-
width : unit-spec, default: :rc:`colorbar.width` or :rc:`colorbar.insetwidth
3648+
width : unit-spec, default: :rc:`colorbar.width` or :rc:`colorbar.insetwidth`
36503649
The colorbar width. For outer colorbars, floats are interpreted as inches
36513650
(default is :rcraw:`colorbar.width`). For inset colorbars, floats are
36523651
interpreted as em-widths (default is :rcraw:`colorbar.insetwidth`).

0 commit comments

Comments
 (0)