Skip to content

Figure.basemap: Improve the docstring for coltypes #4856

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.

Sign up for GitHub

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

Open
seisman wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Figure.basemap: Improve the docstring for coltypes #4856

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
df585a7
Figure.basemap: Improve the docstring for coltypes
seisman Aug 25, 2026
3044362
Fix the link to GMT documentation
seisman Aug 25, 2026
6041085
Merge branch 'main' into basemap/coltypes
seisman Aug 26, 2026
bf77716
Merge branch 'main' into basemap/coltypes
seisman Aug 26, 2026
275e44a
Merge branch 'main' into basemap/coltypes
seisman Aug 26, 2026
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
14 changes: 8 additions & 6 deletions pygmt/src/basemap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ def basemap(
zsize: float | str | None = None,
region: Sequence[float | str] | str | None = None,
frame: Frame | Axis | Literal["none"] | str | Sequence[str] | bool = False,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
map_scale: str | None = None,
compass: str | None = None,
rose: str | None = None,
box: Box | str | bool = False,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
Comment thread
seisman marked this conversation as resolved.
panel: int | Sequence[int] | bool = False,
coltypes: str | None = None,
perspective: float | Sequence[float] | str | bool = False,
Expand All @@ -35,9 +35,9 @@ def basemap(
"""
Plot base maps and frames.

Creates a basic or fancy basemap with axes, fill, and titles. Several map
projections are available, and separate tick-mark intervals for axis annotation,
ticking, and gridlines can be specified.
Creates a basic or fancy basemap with axes, fill, and title. Several map projections
are available, and separate tick-mark intervals for axis annotation, ticks, and
gridlines can be specified.

If not in subplot mode (see :meth:`pygmt.Figure.subplot`), at least one of the
parameters ``frame``, ``map_scale``, ``rose``, or ``compass`` must be specified.
Expand Down Expand Up @@ -125,7 +125,9 @@ def basemap(
parameters.
$verbose
$panel
$coltypes
coltypes
Specify the types of the coordinates given via ``region``. See
:gmt-docs:`gmt.html#f-full` for details.
$perspective
$transparency

Expand Down
Loading