Skip to content

Commit

Permalink
Remove docs references to deprecated settings
Browse files Browse the repository at this point in the history
  • Loading branch information
lukelbd committed Jan 19, 2022
1 parent c4b93c9 commit 06f711f
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 10 deletions.
15 changes: 8 additions & 7 deletions docs/projections.py
Original file line number Diff line number Diff line change
Expand Up @@ -178,13 +178,14 @@
# non-polar cartopy projections global extent and bounds polar cartopy projections
# at the equator. This is a deviation from cartopy, which determines map boundaries
# automatically based on the coordinates of the plotted content. To revert to
# cartopy's default behavior, set :rcraw:`geo.autoextent` to ``True``.
# * By default, proplot gives circular boundaries to polar cartopy
# projections like `~cartopy.crs.NorthPolarStereo` (see `this example
# <https://scitools.org.uk/cartopy/docs/latest/gallery/lines_and_polygons/always_circular_stereo.html>`__
# from the cartopy website). This is consistent with basemap's behavior. To
# disable this feature, set :rcraw:`geo.circlebounds` to ``False``. Please note
# that cartopy cannot add gridline labels to polar plots with circular boundaries.
# cartopy's default behavior, set :rcraw:`geo.extent` to ``'auto`` or pass
# ``extent='auto'`` to `~proplot.axes.GeoAxes.format`.
# * By default, proplot gives circular boundaries to polar cartopy and basemap
# projections like `~cartopy.crs.NorthPolarStereo` (see `this cartopy example
# <https://scitools.org.uk/cartopy/docs/latest/gallery/lines_and_polygons/always_circular_stereo.html>`__).
# To disable this feature, set :rcraw:`geo.round` to ``False`` or pass
# ``round=False` to `~proplot.axes.GeoAxes.format`. Please note that cartopy
# cannot add gridline labels to polar plots with circular boundaries.
# * To make things more consistent, the `~proplot.constructor.Proj` constructor
# function lets you supply native `PROJ <https://proj.org>`__ keyword names
# for the cartopy `~cartopy.crs.Projection` classes (e.g., `lon_0` instead
Expand Down
6 changes: 3 additions & 3 deletions proplot/axes/geo.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
Whether to bound polar projections with circles rather than squares. Note that outer
gridline labels cannot be added to circle-bounded polar projections. When basemap
is the backend this argument must be passed to `~proplot.constructor.Proj` instead.
extent : {'globe', 'auto'}, default: :rc:`geo.autoextent`
extent : {'globe', 'auto'}, default: :rc:`geo.extent`
*For cartopy axes only*.
Whether to auto adjust the map bounds based on plotted content. If ``'globe'`` then
non-polar projections are fixed with `~cartopy.mpl.geoaxes.GeoAxes.set_global`,
Expand Down Expand Up @@ -312,8 +312,8 @@ def _get_sanitized_ticks(self, locator):

def get_view_interval(self):
# NOTE: Proplot tries to set its *own* view intervals to avoid dateline
# weirdness, but if geo.autoextent is False the interval will be
# unset, so we are forced to use get_extent().
# weirdness, but if geo.extent is 'auto' the interval will be unset, so
# we are forced to use _get_extent().
interval = self._interval
if interval is None:
extent = self._get_extent()
Expand Down

0 comments on commit 06f711f

Please sign in to comment.