Skip to content

Commit

Permalink
Minor docs cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
lukelbd committed Oct 10, 2021
1 parent 87e3333 commit 9b437a4
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 23 deletions.
5 changes: 2 additions & 3 deletions docs/1dplots.py
Expand Up @@ -367,7 +367,7 @@
# In matplotlib, arrays passed to the marker size keyword `s` always represent the
# area in units ``points ** 2``. In proplot, arrays passed to `s` are scaled so
# that the minimum data value has the area ``1`` while the maximum data value
# has the area :rc:`lines.markersize` squared. These minimum and maximum marker
# has the area :rcraw:`lines.markersize` squared. These minimum and maximum marker
# sizes can also be specified manually with the `smin` and `smax` keywords,
# analogous to `vmin` and `vmax` used to scale the color array `c`. This feature
# can be disabled by passing ``absolute_size=True`` to `~proplot.axes.Axes.scatter`
Expand Down Expand Up @@ -411,7 +411,7 @@
data = state.rand(2, 100)
obj = ax.scatter(
*data,
s=state.rand(100), smin=3, smax=60, marker='o',
s=state.rand(100), smin=6, smax=60, marker='o',
c=data.sum(axis=0), cmap='maroon',
colorbar='lr', colorbar_kw={'label': 'label'},
)
Expand Down Expand Up @@ -504,7 +504,6 @@
# are expressed with the `height` keyword. In proplot, bar widths are always
# expressed with the `width` keyword. Note that bar widths can also be passed
# as a third positional argument.
#
# Additionally, matplotlib bar widths are always expressed in data units,
# while proplot bar widths are expressed in step size-relative units by
# default. For example, ``width=1`` with a dependent coordinate step
Expand Down
41 changes: 21 additions & 20 deletions docs/subplots.py
Expand Up @@ -15,19 +15,20 @@
# %% [raw] raw_mimetype="text/restructuredtext"
# .. _ug_layout:
#
# Subplots and gridspecs
# ======================
# Subplots
# ========
#
# This section documents a variety of features related to proplot subplots and
# gridspecs, including a-b-c subplot labels, axis sharing between subplots,
# gridspec spacing between subplots, and a unique feature where the figure
# size is determined from a reference subplot and the gridspec geometry.
# This section documents a variety of features related to proplot subplots,
# including a-b-c subplot labels, axis sharing between subplots, automatic
# spacing between subplots, and a unique feature where the figure size is
# automatically determined from a reference subplot and the subplot geometry.
#
# .. important::
#
# Proplot does not officially support "nested" matplotlib structures like
# `~matplotlib.figure.SubFigure` and `~matplotlib.gridspec.GridSpecFromSubplotSpec`
# and proplot subplots are only allowed to use one `~proplot.figure.Figure.gridspec`
# Proplot does not officially support "nested" matplotlib
# structures like `~matplotlib.figure.SubFigure` and
# `~matplotlib.gridspec.GridSpecFromSubplotSpec`. Also,
# proplot subplots are only allowed to use one `~proplot.figure.Figure.gridspec`
# per figure (see :ref:`this section <ug_subplot>`). These restrictions considerably
# simplify the algorithm used to calculate :ref:`figure sizes <ug_autosize>` and
# :ref:`subplot spaces <ug_tight>` and makes the default :ref:`a-b-c label
Expand Down Expand Up @@ -109,14 +110,14 @@
# ------------
#
# Depending on the keyword arguments passed to `~proplot.figure.Figure`, proplot
# figure sizes may be flexible. By default, the figure size is automatically
# calculated from the figure-wide `~proplot.figure.Figure.gridspec` and the physical
# size of a "reference" subplot whose `~proplot.axes.Axes.number` matches the
# `~proplot.figure.Figure` keyword `refnum` (the default value ``1`` usually
# corresponds to the subplot in the upper-left corner -- see :ref:`this section
# <ug_abc>` for more on subplot numbers). Alternatively, the figure height
# (width) may be automatically calculated from the figure-wide
# `~proplot.figure.Figure.gridspec` and a user-input figure width (height).
# figure sizes may be flexible. By default, the figure size is calculated
# automatically from the `~proplot.figure.Figure.gridspec` geometry and the physical
# size of a "reference" subplot. This subplot has a `~proplot.axes.Axes.number`
# matching the `~proplot.figure.Figure` keyword `refnum` (the default value ``1``
# usually corresponds to the subplot in the upper-left corner -- see :ref:`this
# section <ug_abc>` for more on subplot numbers). Alternatively, the figure
# height (width) may be calculated automatically from the
# `~proplot.figure.Figure.gridspec` geometry and a user-input figure width (height).
#
# The figure size ultimately depends on the following `~proplot.figure.Figure`
# keyword arguments:
Expand Down Expand Up @@ -210,7 +211,7 @@
#
# Depending on the keyword arguments passed to `~proplot.figure.Figure` and
# `~proplot.gridspec.GridSpec`, the spaces between proplot subplots may be flexible.
# By default, the spaces are automatically calculated to accomadate text labels using
# By default, the spaces are calculated automatically to accomadate text labels using
# a custom "tight layout" algorithm. This algorithm can be disabled by passing
# ``tight=False`` to `~proplot.figure.Figure` or by setting :rcraw:`subplots.tight`
# to ``False``. In contrast to `matplotlib's tight layout algorithm
Expand Down Expand Up @@ -302,8 +303,8 @@
# ------------
#
# Figures with lots of subplots often have :ref:`redundant labels <why_redundant>`.
# To help address this, `matplotlib.pyplot.subplots` includes the `sharex` and
# `sharey` keyword arguments that permit sharing axis limits, ticks, and tick labels
# To help address this, the matplotlib command `matplotlib.pyplot.subplots` includes
# `sharex` and `sharey` keywords that permit sharing axis limits, ticks, and tick labels
# between like rows and columns of subplots. Proplot builds on this feature by...
#
# #. Automatically sharing axes between subplots and :ref:`panels <ug_panels>`
Expand Down

0 comments on commit 9b437a4

Please sign in to comment.