Skip to content

POC: List common aliases at the end of docstrings #4286

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

Draft
seisman wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

POC: List common aliases at the end of docstrings #4286

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
530289b
List common aliases at the end of docstrings
seisman Dec 15, 2025
a71c45b
Remove the section heading of 'Common Parameters'
seisman Dec 16, 2025
ca29e23
Fix order
seisman Dec 17, 2025
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: 7 additions & 7 deletions pygmt/src/coast.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ def coast( # noqa: PLR0913
shorelines: bool | str | Sequence[int | str] = False,
box: Box | bool = False,
projection: str | None = None,
frame: str | Sequence[str] | bool = False,
region: Sequence[float | str] | str | None = None,
frame: str | Sequence[str] | bool = False,
verbose: Literal["quiet", "error", "warning", "timing", "info", "compat", "debug"]
| bool = False,
panel: int | Sequence[int] | bool = False,
transparency: float | None = None,
perspective: float | Sequence[float] | str | bool = False,
transparency: float | None = None,
**kwargs,
):
r"""
Expand Down Expand Up @@ -72,11 +72,7 @@ def coast( # noqa: PLR0913

Parameters
----------
$projection
$region
*Required if this is the first plot command.*
$area_thresh
$frame
lakes : str or list
*fill*\ [**+l**\|\ **+r**].
Set the shade, color, or pattern for lakes and river-lakes. The
Expand Down Expand Up @@ -196,10 +192,14 @@ def coast( # noqa: PLR0913
to any of the continent codes (e.g. ``"=EU"`` for Europe). Append
**+p**\ *pen* to draw polygon outlines [Default is no outline] and
**+g**\ *fill* to fill them [Default is no fill].
$projection
$region
*Required if this is the first plot command.*
$frame
$verbose
$panel
$perspective
$transparency
$verbose

Example
-------
Expand Down