Skip to content

Commit 00d5a86

Browse files
committed
Fix outdated links and cleanup api docs
1 parent 4445ab2 commit 00d5a86

23 files changed

+103
-101
lines changed

WHATSNEW.rst

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -112,8 +112,8 @@ ProPlot v0.7.0 (2021-07-##)
112112
* When using ``medians=True`` or ``means=True`` with `indicate_error` plot simple
113113
error bars by default instead of bars and "boxes" (:commit:`4e30f415`). Only plot
114114
"boxes" with central "markers" by default for violin plots (:commit:`13b45ccd`).
115-
* `legend_wrapper` no longer returns the background patch generated for centered-row
116-
legends (:pr:`254`). This is consistent with `colorbar_wrapper` not returning
115+
* `legend_extras` no longer returns the background patch generated for centered-row
116+
legends (:pr:`254`). This is consistent with `colorbar_extras` not returning
117117
background patches generated for inset colorbars. Until proplot adds new subclasses,
118118
it makes more sense if these functions only return `~matplotlib.legend.Legend` and
119119
`~matplotlib.colorbar.Colorbar` instances.
@@ -129,8 +129,16 @@ ProPlot v0.7.0 (2021-07-##)
129129
* Add `wequal`, `hequal`, and `equal` options to still use automatic spacing but force
130130
the tight layout algorithm to make spacings equal (:pr:`215`, :issue:`64`)
131131
by `Zachary Moon`_.
132-
* Add baseline support for "3D" `~matplotlib.mpl_toolkits.mplot3d.Axes3D` axes
132+
* Add minimal support for "3D" `~matplotlib.mpl_toolkits.mplot3d.Axes3D` axes
133133
(:issue:`249`). Example usage: ``fig.subplots(proj='3d')``.
134+
* Add `~proplot.axes.Axes.plotx` and `~proplot.axes.Axes.scatterx` commands that
135+
interpret plotting args as ``(y, x)`` rather than ``(x, y)``, analogous to
136+
`~proplot.axes.Axes.areax` (:commit:`###`).
137+
* Add support for `~proplot.axes.indicate_error` *horizontal* error bars and
138+
shading for line and scatter plots (:commit:`###`).
139+
* Add support for ``ax.plot_command('x_key', 'y_key', data=dataset)`` for
140+
virtually all plotting commands using `standardize_1d` and `standardize_2d`
141+
(:commit:`###`). This was an existing `~matplotlib.axes.Axes.plot` feature.
134142
* Allow updating axes fonts that use scalings like ``'small'`` and ``'large'``
135143
by passing ``fontsize=N`` to `format` (:issue:`212`).
136144
* Interpret fontsize-relative legend rc params like ``legend.borderpad``
@@ -184,6 +192,9 @@ ProPlot v0.7.0 (2021-07-##)
184192
``'a'`` or ``'A'`` in string, and only replace that one (:issue:`201`).
185193
* Allow passing e.g. ``barstds=3`` or ``barpctiles=90`` to request error bars
186194
denoting +/-3 standard deviations and 5-95 percentile range (:commit:`4e30f415`).
195+
* Add singular `indicate_error` keywords `barstd`, `barpctile`, etc. as
196+
alternatives to `barstds`, `barpctiles`, etc. (:commit:`81151a58`).
197+
Also prefer them in the documentation.
187198
* Allow passing ``means=True`` to `boxplot` to toggle mean line
188199
(:commit:`4e30f415`).
189200
* Allow setting the mean and median boxplot linestyle with

docs/axis.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
# --------------
3232
#
3333
# `Tick locators\
34-
# <https://matplotlib.org/3.2.1/gallery/ticks_and_spines/tick-locators.html>`__
34+
# <https://matplotlib.org/stable/gallery/ticks_and_spines/tick-locators.html>`__
3535
# are used to automatically select sensible tick locations
3636
# based on the axis data limits. In ProPlot, you can change the tick locator
3737
# using the `~proplot.axes.Axes.format` keyword arguments `xlocator`,
@@ -126,7 +126,7 @@
126126
# -----------
127127
#
128128
# `Tick formatters\
129-
# <https://matplotlib.org/3.2.1/gallery/ticks_and_spines/tick-formatters.html>`__
129+
# <https://matplotlib.org/stable/gallery/ticks_and_spines/tick-formatters.html>`__
130130
# are used to convert floating point numbers to
131131
# nicely-formatted tick labels. In ProPlot, you can change the tick formatter
132132
# using the `~proplot.axes.Axes.format` keyword arguments `xformatter` and
@@ -493,7 +493,7 @@
493493
# In the below examples, we generate dual axes with each of these three methods. Note
494494
# that the "parent" axis scale is now arbitrary -- in the first example shown below,
495495
# we create a `~proplot.axes.CartesianAxes.dualx` axis for an axis scaled by the
496-
# `symlog scale <https://matplotlib.org/3.1.0/gallery/scales/symlog_demo.html>`__.
496+
# `symlog scale <https://matplotlib.org/stable/gallery/scales/symlog_demo.html>`__.
497497

498498
# %%
499499
import proplot as plot

docs/basics.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@
153153
# --------------
154154
#
155155
# Matplotlib has
156-
# `two different interfaces <https://matplotlib.org/3.2.1/api/index.html>`__:
156+
# `two different interfaces <https://matplotlib.org/stable/api/index.html>`__:
157157
# an object-oriented interface and a MATLAB-style `~matplotlib.pyplot` interface
158158
# (which uses the object-oriented interface internally). Plotting with ProPlot is
159159
# just like plotting with matplotlib's *object-oriented* interface. Proplot builds
@@ -321,7 +321,7 @@
321321
# :ref:`ProPlot settings <rc_proplot>`. `~proplot.config.rc` also
322322
# provides a ``style`` parameter that can be used to switch between
323323
# `matplotlib stylesheets\
324-
# <https://matplotlib.org/3.1.1/gallery/style_sheets/style_sheets_reference.html>`__.
324+
# <https://matplotlib.org/stable/gallery/style_sheets/style_sheets_reference.html>`__.
325325
# See the :ref:`configuration section <ug_config>` for details.
326326
#
327327
# To modify a setting for just one subplot, you can pass it to the

docs/configuration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ The .proplotrc file
9898

9999
When you install ProPlot for the first time, a ``.proplotrc`` file is generated
100100
and placed in your home directory. This is just like the `matplotlibrc file\
101-
<https://matplotlib.org/3.1.1/tutorials/introductory/customizing.html#customizing-with-matplotlibrc-files>`__,
101+
<https://matplotlib.org/stable/tutorials/introductory/customizing.html#customizing-with-matplotlibrc-files>`__,
102102
but for changing both ProPlot *and* matplotlib settings. The syntax is basically
103103
the same as the ``matplotlibrc`` syntax.
104104

docs/cycles.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
# instances so that they can be `used with categorical data\
2727
# <https://journals.ametsoc.org/view-large/figure/9538246/bams-d-13-00155_1-f5.tif>`__.
2828
# Much more commonly, we build `property cycles\
29-
# <https://matplotlib.org/3.1.0/tutorials/intermediate/color_cycle.html>`__
29+
# <https://matplotlib.org/stable/tutorials/intermediate/color_cycle.html>`__
3030
# from the `~proplot.colors.ListedColormap` colors using the
3131
# `~proplot.constructor.Cycle` constructor function or by
3232
# :ref:`drawing samples <ug_cycles_new>` from continuous colormaps.

docs/fonts.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
#
3333
# Matplotlib provides a `~matplotlib.font_manager` module for working with
3434
# system fonts and classifies fonts into `five font families\
35-
# <https://matplotlib.org/3.1.1/gallery/text_labels_and_annotations/fonts_demo.html>`__:
35+
# <https://matplotlib.org/stable/gallery/text_labels_and_annotations/fonts_demo.html>`__:
3636
# :rcraw:`font.serif` :rcraw:`font.sans-serif`, :rcraw:`font.monospace`,
3737
# :rcraw:`font.cursive`, and :rcraw:`font.fantasy`. The default font family
3838
# is sans-serif, because sans-serif fonts are generally more suitable for

docs/insets_panels.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@
115115
# ----------
116116
#
117117
# `Inset axes\
118-
# <https://matplotlib.org/3.1.1/gallery/subplots_axes_and_figures/zoom_inset_axes.html>`__
118+
# <https://matplotlib.org/stable/gallery/subplots_axes_and_figures/zoom_inset_axes.html>`__
119119
# can be generated with the `~proplot.axes.Axes.inset` or
120120
# `~proplot.axes.Axes.inset_axes` command. By default, inset axes
121121
# have the same projection as the parent axes, but you can also request

docs/projections.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
# %% [raw] raw_mimetype="text/restructuredtext"
1717
#
18-
# .. _polar: https://matplotlib.org/3.1.0/gallery/pie_and_polar_charts/polar_demo.html
18+
# .. _polar: https://matplotlib.org/stable/gallery/pie_and_polar_charts/polar_demo.html
1919
#
2020
# .. _cartopy: https://scitools.org.uk/cartopy/docs/latest/
2121
#
@@ -241,7 +241,7 @@
241241
# `~mpl_toolkits.basemap.addcyclic`.
242242
#
243243
# Geographic features can be drawn underneath data or on top of data by changing the
244-
# corresponding `zorder <https://matplotlib.org/3.1.1/gallery/misc/zorder_demo.html>`__
244+
# corresponding `zorder <https://matplotlib.org/stable/gallery/misc/zorder_demo.html>`__
245245
# setting. For example, to draw land patches on top of all plotted content as
246246
# a "land mask," use ``ax.format(land=True, landzorder=4)`` or set :rcraw:`land.zorder`
247247
# to ``True``. See the :ref:`next section <ug_geoformat>` for details.

docs/subplots.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363
# `nrows` arguments), the arguments `refaspect`, `refwidth`, and `refheight`
6464
# apply to every subplot in the figure -- not just the reference subplot.
6565
# * When the reference subplot `aspect ratio\
66-
# <https://matplotlib.org/2.0.2/examples/pylab_examples/equal_aspect_ratio.html>`__
66+
# <https://matplotlib.org/stable/examples/pylab_examples/equal_aspect_ratio.html>`__
6767
# has been fixed (e.g., using ``ax.set_aspect(1)``) or is set to ``'equal'``
6868
# (as with :ref:`geographic projections <ug_geo>` and
6969
# `~matplotlib.axes.Axes.imshow` images), the fixed aspect ratio is used
@@ -157,7 +157,7 @@
157157
# subplot rows and columns and the figure edge to accommodate labels.
158158
# It can be disabled by passing ``tight=False`` to `~proplot.ui.subplots`.
159159
# While matplotlib has `its own tight layout algorithm
160-
# <https://matplotlib.org/3.1.1/tutorials/intermediate/tight_layout_guide.html>`__,
160+
# <https://matplotlib.org/stable/tutorials/intermediate/tight_layout_guide.html>`__,
161161
# ProPlot's algorithm may change the figure size to accommodate the correct spacing
162162
# and permits variable spacing between subsequent subplot rows and columns (see the
163163
# new `~proplot.gridspec.GridSpec` class for details).

docs/why.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -142,11 +142,11 @@ seconds, typing out these extra class names and import statements can be a major
142142

143143
Parts of matplotlib's interface were actually designed with this in mind.
144144
`Backend classes <https://matplotlib.org/faq/usage_faq.html#what-is-a-backend>`__,
145-
`native axes projections <https://matplotlib.org/3.1.1/api/projections_api.html>`__,
146-
`axis scales <https://matplotlib.org/3.1.0/gallery/scales/scales.html>`__,
147-
`box styles <https://matplotlib.org/3.1.1/api/_as_gen/matplotlib.patches.FancyBboxPatch.html?highlight=boxstyle>`__,
148-
`arrow styles <https://matplotlib.org/3.1.1/api/_as_gen/matplotlib.patches.FancyArrowPatch.html?highlight=arrowstyle>`__,
149-
and `arc styles <https://matplotlib.org/3.1.1/api/_as_gen/matplotlib.patches.ConnectionStyle.html?highlight=class%20name%20attrs>`__
145+
`native axes projections <https://matplotlib.org/stable/api/projections_api.html>`__,
146+
`axis scales <https://matplotlib.org/stable/gallery/scales/scales.html>`__,
147+
`box styles <https://matplotlib.org/stable/api/_as_gen/matplotlib.patches.FancyBboxPatch.html>`__,
148+
`arrow styles <https://matplotlib.org/stable/api/_as_gen/matplotlib.patches.FancyArrowPatch.html>`__,
149+
and `arc styles <https://matplotlib.org/stable/api/_as_gen/matplotlib.patches.ConnectionStyle.html>`__
150150
are referenced with "registered" string names,
151151
as are `basemap projections <https://matplotlib.org/basemap/users/mapsetup.html>`__.
152152
So, why not "register" everything else?
@@ -208,7 +208,7 @@ figure, despite the fact that...
208208
number of subplot tiles in the figure.
209209

210210
Also, while matplotlib's `tight layout algorithm
211-
<https://matplotlib.org/tutorials/intermediate/tight_layout_guide.html>`__
211+
<https://matplotlib.org/stable/tutorials/intermediate/tight_layout_guide.html>`__
212212
helps to avoid tweaking the *spacing*, the algorithm cannot apply different amounts of
213213
spacing between different subplot row and column boundaries.
214214

@@ -218,7 +218,7 @@ In ProPlot, you can specify the physical dimensions of a *reference subplot*
218218
instead of the figure by passing `refwidth`, `refheight`, and/or `refaspect` to
219219
`~proplot.figure.Figure`. The default behavior is ``refaspect=1`` and
220220
``refwidth=2`` (inches). If the `aspect ratio mode
221-
<https://matplotlib.org/2.0.2/examples/pylab_examples/equal_aspect_ratio.html>`__
221+
<https://matplotlib.org/stable/gallery/subplots_axes_and_figures/axis_equal_demo.html>`__
222222
for the reference subplot is set to ``'equal'``, as with
223223
:ref:`geographic and polar <ug_proj>` plots and `~matplotlib.axes.Axes.imshow` plots,
224224
the *imposed* aspect ratio will be used instead.
@@ -331,7 +331,7 @@ difficult to draw "inset" colorbars in matplotlib.
331331
332332
..
333333
The matplotlib example for `~matplotlib.figure.Figure` legends is `not pretty
334-
<https://matplotlib.org/3.1.1/gallery/text_labels_and_annotations/figlegend_demo.html>`__.
334+
<https://matplotlib.org/stable/gallery/text_labels_and_annotations/figlegend_demo.html>`__.
335335
336336
..
337337
Drawing colorbars and legends is pretty clumsy in matplotlib -- especially

0 commit comments

Comments
 (0)