Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit c598508

Browse files
committed
Update why proplot
1 parent d29c2f1 commit c598508

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

‎docs/why.rst

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -274,7 +274,7 @@ provides the following advantages:
274274
:ref:`axes panels <ug_insets_panels>` without "stealing space"
275275
from the parent subplot -- these objects usually need to be
276276
spaced closer to their parents than other subplots.
277-
* You can :ref:`override particular spacing parameters <ug_tight>`
277+
* You can :ref:`override <ug_tight>` particular spacing parameters
278278
and leave the tight layout algorithm to adjust the
279279
unspecified spacing parameters. For example, passing ``right=1`` to
280280
`~proplot.figure.Figure.add_subplots` fixes the right margin
@@ -329,10 +329,10 @@ concise figures.
329329
* The `~proplot.axes.Axes.panel_axes` (shorthand `~proplot.axes.Axes.panel`) commands
330330
can draw :ref:`thin panels <ug_panels>` along the edges of subplots. This
331331
can be useful for plotting 1D summary statistics alongside 2D plots.
332-
* :ref:`A-b-c labels <ug_abc>` can be added to subplots simply using the :rcraw:`abc`
332+
* A-b-c labels can be added to subplots simply using the :rcraw:`abc`
333333
setting -- for example, ``pplt.rc['abc'] = 'A.'`` or ``axs.format(abc='A.')``.
334334
This is possible because `~proplot.figure.Figure.add_subplot` assigns a unique
335-
`~proplot.axes.Axes.number` to every added subplot.
335+
`~proplot.axes.Axes.number` to every new subplot.
336336
* The `proplot.gridspec.SubplotGrid.format` command can easily format multiple subplots
337337
at once or add colorbars, legends, panels, twin axes, or inset axes to multiple
338338
subplots at once. A `~proplot.gridspec.SubplotGrid` is returned by
@@ -393,9 +393,6 @@ Also, `~proplot.figure.Figure` and `~proplot.axes.Axes` colorbar widths are
393393
now specified in *physical* units rather than relative units, which makes
394394
colorbar thickness independent of subplot size and easier to get just right.
395395

396-
There are also several useful new :ref:`colorbar <ug_cbars>` and
397-
:ref:`legend <ug_legends>` features described in the user guide.
398-
399396
Links
400397
-----
401398

@@ -865,27 +862,28 @@ ProPlot settings can be changed persistently by editing the default ``proplotrc`
865862
file in the location given by `~proplot.config.Configurator.user_file` (this is
866863
usually ``$HOME/.proplot/proplotrc``) or by adding ``proplotrc`` files to either
867864
the current directory or any parent directory. Adding files to parent directories
868-
can be useful when working in projects with lots of subfolders. See the
869-
:ref:`user guide <ug_proplotrc>` for details.
865+
can be useful when working in projects with lots of subfolders.
870866

871867
ProPlot also automatically registers colormaps, color cycles, colors, and font
872868
files stored in the ``cmaps``, ``cycles``, ``colors``, and ``fonts`` folders in
873869
the location given by `~proplot.config.Configurator.user_folder` (this is usually
874870
``$HOME/.proplot``). You can save colormaps and color cycles to these
875871
folders simply by passing ``save=True`` to `~proplot.constructor.Colormap` and
876-
`~proplot.constructor.Cycle`. To explicitly register objects stored in these folders,
877-
or to register arbitrary input arguments, you can use `~proplot.config.register_cmaps`,
872+
`~proplot.constructor.Cycle`. To manually register these files, or to
873+
register arbitrary input arguments, you can use `~proplot.config.register_cmaps`,
878874
`~proplot.config.register_cycles`, `~proplot.config.register_colors`, or
879875
`~proplot.config.register_fonts`.
880876

881877
Links
882878
-----
883879

884-
* For importing custom colormaps,
880+
* For the ``proplotrc`` file,
881+
see :ref:`this page <ug_proplotrc>`.
882+
* For registering colormaps,
885883
see :ref:`this page <ug_cmaps_dl>`.
886-
* For importing custom color cycles,
884+
* For registering color cycles,
887885
see :ref:`this page <ug_cycles_dl>`.
888-
* For importing custom colors,
886+
* For registering colors,
889887
see :ref:`this page <ug_colors_user>`.
890-
* For importing custom fonts,
888+
* For registering fonts,
891889
see :ref:`this page <ug_fonts_user>`.

0 commit comments

Comments
 (0)