Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: coastlines 'auto' clarification #2204

Merged
merged 1 commit into from
Jun 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions lib/cartopy/feature/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -479,8 +479,8 @@ def intersecting_geometries(self, extent):

auto_scaler = AdaptiveScaler('110m', (('50m', 50), ('10m', 15)))
"""AdaptiveScaler for NaturalEarthFeature. Default scale is '110m'.
'110m' is used above 50 degrees, '50m' for 50-15 degrees and '10m' below 15
degrees."""
'110m' is used when both latitudes and longitudes span more than 50 degrees,
'50m' for 50-15 degrees and '10m' below 15 degrees."""


BORDERS = NaturalEarthFeature(
Expand Down
3 changes: 2 additions & 1 deletion lib/cartopy/mpl/geoaxes.py
Original file line number Diff line number Diff line change
Expand Up @@ -629,7 +629,8 @@ def coastlines(self, resolution='auto', color='black', **kwargs):
resolution : str or :class:`cartopy.feature.Scaler`, optional
A named resolution to use from the Natural Earth
dataset. Currently can be one of "auto" (default), "110m", "50m",
and "10m", or a Scaler object.
and "10m", or a Scaler object. If "auto" is selected, the
resolution is defined by `~cartopy.feature.auto_scaler`.

"""
kwargs['edgecolor'] = color
Expand Down