Skip to content

Commit 3f16210

Browse files
committed
Better 'projections' intro
1 parent 88289d7 commit 3f16210

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

docs/projections.py

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -101,16 +101,17 @@
101101
# where ``name`` is any valid :ref:`PROJ projection name <proj_included>`.
102102
# You can also generate a `cartopy.crs.Projection` or `mpl_toolkits.basemap.Basemap`
103103
# instance directly using the `~proplot.constructor.Proj` constructor function and
104-
# pass the class instance to `proj`.
104+
# pass the class instance with ``proj=<object>``.
105105
#
106+
# When you request a geographic projection,
106107
# `~proplot.ui.subplots` returns instances of `proplot.axes.CartopyAxes`
107108
# or `proplot.axes.BasemapAxes`, depending on whether ``basemap=True`` was used.
108109
# Both of these derive from `proplot.axes.GeoAxes`, which includes a
109-
# `~proplot.axes.GeoAxes.format` method that can be used to control various
110-
# :ref:`geographic features <ug_geoformat>` with the same syntax whether
111-
# cartopy or basemap is the backend.
110+
# `~proplot.axes.GeoAxes.format` method. This method allows you to
111+
# :ref:`modify geographic features <ug_geoformat>` with the same syntax whether
112+
# cartopy or basemap is the "backend".
112113
#
113-
# * `proplot.axes.CartopyAxes` unifies cartopy's `~cartopy.mpl.geoaxes.GeoAxes`
114+
# * `proplot.axes.CartopyAxes` unifies the `cartopy.mpl.geoaxes.GeoAxes`
114115
# class with the `proplot.axes.Axes` class. The `~proplot.axes.GeoAxes.format`
115116
# method changes map bounds with
116117
# `~cartopy.mpl.geoaxes.GeoAxes.set_extent`, adds major and minor gridlines with
@@ -130,11 +131,12 @@
130131
# use it, the corresponding `~mpl_toolkits.basemap.Basemap` instance is
131132
# available via the `proplot.axes.BasemapAxes.projection` attribute.
132133
#
133-
# These features mean you no longer have to invoke verbose cartopy classes like
134-
# `~cartopy.crs.LambertAzimuthalEqualArea` and `~cartopy.feature.NaturalEarthFeature`,
135-
# and you no longer have to directly work with the `~mpl_toolkits.basemap.Basemap`
136-
# instance. In the below examples, we create a variety of geographic plots with
137-
# both cartopy and basemap as the backends.
134+
# These features let you work with geographic data without having to invoke verbose
135+
# cartopy classes like `~cartopy.crs.LambertAzimuthalEqualArea` and
136+
# `~cartopy.feature.NaturalEarthFeature` or keep track of a separate
137+
# `~mpl_toolkits.basemap.Basemap` object. They considerably reduce the amount of
138+
# code needed to make geographic plots. In the below examples, we create a variety
139+
# of geographic plots with both cartopy and basemap as the backends.
138140
#
139141
# .. note::
140142
#

0 commit comments

Comments
 (0)