Skip to content

Commit 487ea38

Browse files
committed
Change why proplot section headers
1 parent bf23a2b commit 487ea38

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

docs/why.rst

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -79,10 +79,10 @@ into the figure architecture and apply settings to several different objects.
7979
It seems like there should be a more unified, straightforward way to change
8080
settings without sacrificing the advantages of object-oriented design.
8181

82-
Solution
83-
--------
82+
Changes
83+
-------
8484

85-
Proplot introduces the `proplot.axes.Axes.format` command to resolve this.
85+
Proplot includes the `proplot.axes.Axes.format` command to resolve this.
8686
Think of this as an expanded and thoroughly documented version of the
8787
`matplotlib.artist.Artist.update` command. `~proplot.axes.Axes.format` can modify things
8888
like axis labels and titles and apply new :ref:`"rc" settings <why_rc>` to existing
@@ -155,8 +155,8 @@ are referenced with "registered" string names,
155155
as are `basemap projections <https://matplotlib.org/basemap/users/mapsetup.html>`__.
156156
So, why not "register" everything else?
157157

158-
Solution
159-
--------
158+
Changes
159+
-------
160160

161161
In proplot, tick locators, tick formatters, axis scales, property cycles, colormaps,
162162
normalizers, and `cartopy`_ projections are all "registered". This is accomplished
@@ -237,8 +237,8 @@ parameters like `left`, `bottom`, and `wspace`. However, this algorithm is disab
237237
by default, and it cannot apply different amounts of spacing between different
238238
subplot row and column boundaries.
239239

240-
Solution
241-
--------
240+
Changes
241+
-------
242242

243243
By default, proplot fixes the physical dimensions of a *reference subplot* rather
244244
than the figure. The reference subplot dimensions are controlled with the `refwidth`,
@@ -311,8 +311,8 @@ valuable page space. It is also generally necessary to add "a-b-c" labels to
311311
figures with multiple subplots before submitting them to publications, but
312312
matplotlib has no built-in way of doing this.
313313

314-
Solution
315-
--------
314+
Changes
315+
-------
316316

317317
Proplot makes it easier to work with multiple subplots and create clear,
318318
concise figures.
@@ -365,8 +365,8 @@ This can cause asymmetry in figures with more than one subplot. It is also gener
365365
difficult to draw "inset" colorbars in matplotlib and to generate outer colorbars
366366
with consistent widths (i.e., not too "skinny" or "fat").
367367

368-
Solution
369-
--------
368+
Changes
369+
-------
370370

371371
Proplot includes a simple framework for drawing colorbars and legends
372372
that reference :ref:`individual subplots <ug_guides_loc>` and
@@ -416,8 +416,8 @@ A few common plotting tasks take a lot of work using matplotlib alone. The `seab
416416
`xarray`_, and `pandas`_ packages offer improvements, but it would be nice to
417417
have this functionality built right into matplotlib's interface.
418418

419-
Solution
420-
--------
419+
Changes
420+
-------
421421

422422
Proplot uses the `~proplot.axes.PlotAxes` subclass to add various `seaborn`_,
423423
`xarray`_, and `pandas`_ features to existing matplotlib plotting commands
@@ -548,8 +548,8 @@ rather than longitude-latitude coordinates. This choice is confusing for
548548
many users, since the vast majority of geophysical data are stored with
549549
longitude-latitude (i.e., "Plate Carrée") coordinates.
550550

551-
Solution
552-
--------
551+
Changes
552+
-------
553553

554554
Proplot can succinctly create detailed geographic plots using either cartopy or
555555
basemap as "backends". By default, cartopy is used, but basemap can be used by passing
@@ -609,8 +609,8 @@ learning a different syntax from matplotlib, and tends to encourage using the
609609
``plot`` commands also include features that would be useful additions to matplotlib
610610
in their own right, without requiring special containers and a separate interface.
611611

612-
Solution
613-
--------
612+
Changes
613+
-------
614614

615615
Proplot reproduces many of the `xarray.DataArray.plot`,
616616
`pandas.DataFrame.plot`, and `pandas.Series.plot`
@@ -676,8 +676,8 @@ However in our opinion, it is not very aesthetically pleasing. It is also
676676
difficult to switch to other fonts on limited systems or systems with fonts
677677
stored in incompatible file formats (see :ref:`below <why_dotproplot>`).
678678

679-
Solution
680-
--------
679+
Changes
680+
-------
681681

682682
Proplot adds new colormaps, colors, and fonts to help you make more
683683
aesthetically pleasing figures.
@@ -732,12 +732,12 @@ scratch. Meanwhile, property cycles used for individual plot elements are implem
732732
with the `~cycler.Cycler` class. They are easier to modify but they cannot be
733733
"registered" by name like colormaps.
734734

735-
The `seaborn`_ package introduces "color palettes" to make working with colormaps
736-
and property cycles easier, but it would be nice to have similar features integrated
737-
more closely with matplotlib.
735+
The `seaborn`_ package includes "color palettes" to make working with colormaps
736+
and property cycles easier, but it would be nice to have similar features
737+
integrated more closely with matplotlib's colormap and property cycle constructs.
738738

739-
Solution
740-
--------
739+
Changes
740+
-------
741741

742742
Proplot tries to make it easy to manipulate colormaps and property cycles.
743743

@@ -795,8 +795,8 @@ readjusted.
795795
Matplotlib also requires users to set the figure size `figsize` in inches.
796796
This may be confusing for users outside of the United States.
797797

798-
Solution
799-
--------
798+
Changes
799+
-------
800800

801801
Proplot uses physical units for the `~proplot.gridspec.GridSpec` keywords
802802
`left`, `right`, `top`, `bottom`, `wspace`, `hspace`, `pad`, `outerpad`, and
@@ -834,8 +834,8 @@ useful to set all at once, like spine and label colors. It might also
834834
be useful to change these settings for individual subplots rather
835835
than globally.
836836

837-
Solution
838-
--------
837+
Changes
838+
-------
839839

840840
In proplot, you can use the `~proplot.config.rc` object to change both native
841841
matplotlib settings (found in `~proplot.config.rc_matplotlib`) and added proplot
@@ -872,8 +872,8 @@ future use. It is also difficult to get matplotlib to use custom ``.ttf`` and
872872
``.otf`` font files, which may be desirable when you are working on
873873
Linux servers with limited font selections.
874874

875-
Solution
876-
--------
875+
Changes
876+
-------
877877

878878
Proplot settings can be changed persistently by editing the default ``proplotrc``
879879
file in the location given by `~proplot.config.Configurator.user_file` (this is

0 commit comments

Comments
 (0)