Skip to content

Commit d8809b8

Browse files
committed
Fix wrong formatting in docs
1 parent 70ba5e1 commit d8809b8

File tree

8 files changed

+15
-15
lines changed

8 files changed

+15
-15
lines changed

ultraplot/axes/base.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -377,8 +377,8 @@
377377
Additional titles in specific positions (see `title` for details). This works as
378378
an alternative to the ``ax.format(title='Title', titleloc=loc)`` workflow and
379379
permits adding more than one title-like label for a single axes.
380-
a, alpha, fc, facecolor, ec, edgecolor, lw, linewidth, ls, linestyle : default: \\
381-
:rc:`axes.alpha` (default: 1.0), :rc:`axes.facecolor` (default: white), :rc:`axes.edgecolor` (default: black), :rc:`axes.linewidth` (default: 0.6), -
380+
a, alpha, fc, facecolor, ec, edgecolor, lw, linewidth, ls, linestyle : default:
381+
:rc:`axes.alpha` (default: 1.0), :rc:`axes.facecolor` (default: white), :rc:`axes.edgecolor` (default: black), :rc:`axes.linewidth` (default: 0.6), -
382382
Additional settings applied to the background patch, and their
383383
shorthands. Their defaults values are the ``'axes'`` properties.
384384
"""

ultraplot/axes/geo.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -210,7 +210,7 @@
210210
must be passed to `~ultraplot.constructor.Proj` instead.
211211
color : color-spec, default: :rc:`meta.color`
212212
The color for the axes edge. Propagates to `labelcolor` unless specified
213-
otherwise (similar to :func:`ultraplot.axes.CartesianAxes.format`).
213+
otherwise (similar to :func:`~ultraplot.axes.CartesianAxes.format`).
214214
gridcolor : color-spec, default: :rc:`grid.color`
215215
The color for the gridline labels.
216216
labelcolor : color-spec, default: `color` or :rc:`grid.labelcolor`

ultraplot/axes/plot.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -951,7 +951,7 @@
951951
**kwargs
952952
Passed to `~matplotlib.axes.Axes.scatter`.
953953
954-
See for more info on the grouping behavior :func:`~ultraplot.PlotAxes.bar`, and for formatting :func:~ultraplot.PlotAxes.scatter`.
954+
See for more info on the grouping behavior :func:`~ultraplot.PlotAxes.bar`, and for formatting :func:`~ultraplot.PlotAxes.scatter`.
955955
Returns
956956
-------
957957
List of ~matplotlib.collections.PatchCollection, and a ~matplotlib.collections.LineCollection
@@ -1282,8 +1282,8 @@
12821282
Parameters
12831283
----------
12841284
g : networkx.Graph
1285-
The graph object to be plotted. Can be any subclass of :class:`networkx.Graph`, such as
1286-
:class:`networkx.DiGraph` or :class:`networkx.MultiGraph`.
1285+
The graph object to be plotted. Can be any subclass of :class:`~networkx.Graph`, such as
1286+
:class:`~networkx.DiGraph` or :class:`~networkx.MultiGraph`.
12871287
layout : callable or dict, optional
12881288
A layout function or a precomputed dict mapping nodes to 2D positions. If a function
12891289
is given, it is called as ``layout(g, **layout_kw)`` to compute positions. See :func:`networkx.drawing.nx_pylab.draw` for more information.

ultraplot/axes/polar.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@
8383
`~ultraplot.constructor.Formatter`.
8484
color : color-spec, default: :rc:`meta.color`
8585
Color for the axes edge. Propagates to `labelcolor` unless specified
86-
otherwise (similar to :func:`ultraplot.axes.CartesianAxes.format`).
86+
otherwise (similar to :func:`~ultraplot.axes.CartesianAxes.format`).
8787
labelcolor, gridlabelcolor : color-spec, default: `color` or :rc:`grid.labelcolor`
8888
Color for the gridline labels.
8989
labelpad, gridlabelpad : unit-spec, default: :rc:`grid.labelpad`

ultraplot/colors.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -584,7 +584,7 @@ def _make_lookup_table(N, data, gamma=1.0, inverse=False):
584584
y = y_{1,i} + w_i^{\gamma_i}*(y_{0,i+1} - y_{1,i})
585585
586586
where `\gamma_i` corresponds to `gamma` and the weight `w_i` ranges from
587-
0 to 1 between rows ``i`` and ``i+1``. If `gamma` is float, it applies
587+
0 to 1 between rows `i` and ``i+1``. If `gamma` is float, it applies
588588
to every transition. Otherwise, its length must equal ``data.shape[0]-1``.
589589
590590
This is similar to the `matplotlib.colors.makeMappingArray` `gamma` except
@@ -3057,7 +3057,7 @@ def __getitem__(self, key):
30573057
The number is the color list index.
30583058
30593059
This works everywhere that colors are used in matplotlib, for
3060-
example as `color`, `edgecolor', or `facecolor` keyword arguments
3060+
example as `color`, `edgecolor`, or `facecolor` keyword arguments
30613061
passed to :class:`~ultraplot.axes.PlotAxes` commands.
30623062
"""
30633063
key = self._parse_key(key)

ultraplot/figure.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@
313313
The axes number used for a-b-c labeling. See `~ultraplot.axes.Axes.format` for
314314
details. By default this is incremented automatically based on the other subplots
315315
in the figure. Use e.g. ``number=None`` or ``number=False`` to ensure the subplot
316-
has no a-b-c label. Note the number corresponding to ``a`` is ``1``, not ``0``.
316+
has no a-b-c label. Note the number corresponding to `a` is ``1``, not ``0``.
317317
autoshare : bool, default: True
318318
Whether to automatically share the *x* and *y* axes with subplots spanning the
319319
same rows and columns based on the figure-wide `sharex` and `sharey` settings.

ultraplot/internals/rcsetup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -943,8 +943,8 @@ def copy(self):
943943
False,
944944
_validate_abc,
945945
"If ``False`` then a-b-c labels are disabled. If ``True`` the default label "
946-
"style ``a`` is used. If string this indicates the style and must contain the "
947-
"character ``a`` or ``A``, for example ``'a.'`` or ``'(A)'``.",
946+
"style `a` is used. If string this indicates the style and must contain the "
947+
"character `a` or ``A``, for example ``'a.'`` or ``'(A)'``.",
948948
),
949949
"abc.border": (
950950
True,

ultraplot/scale.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
def _parse_logscale_args(*keys, **kwargs):
3737
"""
3838
Parse arguments for `LogScale` and `SymmetricalLogScale` that
39-
inexplicably require ``x`` and ``y`` suffixes by default. Also
39+
inexplicably require `x` and `y` suffixes by default. Also
4040
change the default `linthresh` to ``1``.
4141
"""
4242
# NOTE: Scale classes ignore unused arguments with warnings, but matplotlib 3.3
@@ -186,7 +186,7 @@ def __init__(self, **kwargs):
186186
class LogScale(_Scale, mscale.LogScale):
187187
"""
188188
As with `~matplotlib.scale.LogScale` but with `~ultraplot.ticker.AutoFormatter`
189-
as the default major formatter. ``x`` and ``y`` versions of each keyword
189+
as the default major formatter. `x` and `y` versions of each keyword
190190
argument are no longer required.
191191
"""
192192

@@ -224,7 +224,7 @@ class SymmetricalLogScale(_Scale, mscale.SymmetricalLogScale):
224224
"""
225225
As with `~matplotlib.scale.SymmetricalLogScale` but with
226226
`~ultraplot.ticker.AutoFormatter` as the default major formatter.
227-
``x`` and ``y`` versions of each keyword argument are no longer
227+
`x` and `y` versions of each keyword argument are no longer
228228
required.
229229
"""
230230

0 commit comments

Comments
 (0)