Skip to content

Commit 275de77

Browse files
committed
Clean up standardize_2d documentation
1 parent 9cad490 commit 275de77

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

proplot/wrappers.py

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -467,25 +467,29 @@ def standardize_2d(self, func, *args, order='C', globe=False, **kwargs):
467467
468468
* If *x* and *y* or *latitude* and *longitude* coordinates were not
469469
provided, and a `~pandas.DataFrame` or `~xarray.DataArray` is passed, we
470-
try to infer them from the metadata. Otherwise,
471-
``np.arange(0, data.shape[0])`` and ``np.arange(0, data.shape[1])``
472-
are used.
470+
try to infer them from the metadata. Otherwise, ``np.arange(0, data.shape[0])``
471+
and ``np.arange(0, data.shape[1])`` are used.
473472
* For ``pcolor`` and ``pcolormesh``, coordinate *edges* are calculated
474473
if *centers* were provided. For all other methods, coordinate *centers*
475474
are calculated if *edges* were provided.
476475
477-
For `~proplot.axes.CartopyAxes` and `~proplot.axes.BasemapAxes`, the
478-
`globe` keyword arg is added, suitable for plotting datasets with global
479-
coverage. Passing ``globe=True`` does the following:
480-
481-
1. "Interpolates" input data to the North and South poles.
482-
2. Makes meridional coverage "circular", i.e. the last longitude coordinate
483-
equals the first longitude coordinate plus 360\N{DEGREE SIGN}.
484-
485-
For `~proplot.axes.BasemapAxes`, 1d longitude vectors are also cycled to
486-
fit within the map edges. For example, if the projection central longitude
487-
is 90\N{DEGREE SIGN}, the data is shifted so that it spans
488-
-90\N{DEGREE SIGN} to 270\N{DEGREE SIGN}.
476+
Parameters
477+
----------
478+
order : {'C', 'F'}, optional
479+
If ``'C'``, arrays should be shaped as ``(y, x)``. If ``'F'``, arrays
480+
should be shaped as ``(x, y)``. Default is ``'C'``.
481+
globe : bool, optional
482+
Whether to ensure global coverage for `~proplot.axes.GeoAxes` plots.
483+
Default is ``False``. When set to ``True`` this does the following:
484+
485+
#. Interpolates input data to the North and South poles by setting the data
486+
values at the poles to the mean from latitudes nearest each pole.
487+
#. Makes meridional coverage "circular", i.e. the last longitude coordinate
488+
equals the first longitude coordinate plus 360\N{DEGREE SIGN}.
489+
#. For `~proplot.axes.BasemapAxes`, 1D longitude vectors are also cycled to
490+
fit within the map edges. For example, if the projection central longitude
491+
is 90\N{DEGREE SIGN}, the data is shifted so that it spans -90\N{DEGREE SIGN}
492+
to 270\N{DEGREE SIGN}.
489493
490494
See also
491495
--------

0 commit comments

Comments
 (0)