From b405e3e6a7fae3826b60d3cf750c84e335591083 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 24 Aug 2026 19:33:08 +0800 Subject: [PATCH] Sort the alias lists in docstrings alphabetically The "Aliases" list in docstrings is sorted by GMT option, uppercase options first, then lowercase ones. Seven docstrings had entries out of order: - Figure.choropleth: R/N and W/V - Figure.legend: D/B - Figure.solar: t/p - pygmt.grd2cpt: Z/V - pygmt.makecpt: Z/V - pygmt.project: W/V - pygmt.sph2grd: r/i Docstring-only change; the entries themselves are unchanged. Note that Figure.basemap, Figure.grdview and Figure.plot3d intentionally list 'Jz' before 'JZ', matching GMT's own '-Jz|Z' documentation order, so they are left as they are. Co-Authored-By: Claude Opus 5 --- pygmt/src/choropleth.py | 4 ++-- pygmt/src/grd2cpt.py | 2 +- pygmt/src/legend.py | 2 +- pygmt/src/makecpt.py | 2 +- pygmt/src/project.py | 2 +- pygmt/src/solar.py | 2 +- pygmt/src/sph2grd.py | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/pygmt/src/choropleth.py b/pygmt/src/choropleth.py index 09f77f2bae1..812271dc51f 100644 --- a/pygmt/src/choropleth.py +++ b/pygmt/src/choropleth.py @@ -50,10 +50,10 @@ def choropleth( - C = cmap - I = intensity - J = projection - - R = region - N = no_clip - - W = pen + - R = region - V = verbose + - W = pen - a = column - c = panel - p = perspective diff --git a/pygmt/src/grd2cpt.py b/pygmt/src/grd2cpt.py index 967d6adacd0..f7ad10fc258 100644 --- a/pygmt/src/grd2cpt.py +++ b/pygmt/src/grd2cpt.py @@ -92,8 +92,8 @@ def grd2cpt( - N = no_bg - Q = log - R = region - - Z = continuous - V = verbose + - Z = continuous Parameters ---------- diff --git a/pygmt/src/legend.py b/pygmt/src/legend.py index 5e5f320e3ac..488ca009a17 100644 --- a/pygmt/src/legend.py +++ b/pygmt/src/legend.py @@ -51,8 +51,8 @@ def legend( .. hlist:: :columns: 3 - - D = position, **+w**: width/height, **+l**: line_spacing - B = frame + - D = position, **+w**: width/height, **+l**: line_spacing - F = box - J = projection - R = region diff --git a/pygmt/src/makecpt.py b/pygmt/src/makecpt.py index f601f90f17d..37c91a45f39 100644 --- a/pygmt/src/makecpt.py +++ b/pygmt/src/makecpt.py @@ -79,8 +79,8 @@ def makecpt( - M = overrule_bg - N = no_bg - Q = log - - Z = continuous - V = verbose + - Z = continuous Parameters ---------- diff --git a/pygmt/src/project.py b/pygmt/src/project.py index 709227ff599..33f4da1ceca 100644 --- a/pygmt/src/project.py +++ b/pygmt/src/project.py @@ -116,8 +116,8 @@ def project( - E = endpoint - L = length - T = pole - - W = width - V = verbose + - W = width - f = coltypes Parameters diff --git a/pygmt/src/solar.py b/pygmt/src/solar.py index a8f3c959689..7b51dd02a2b 100644 --- a/pygmt/src/solar.py +++ b/pygmt/src/solar.py @@ -53,8 +53,8 @@ def solar( - V = verbose - W = pen - c = panel - - t = transparency - p = perspective + - t = transparency Parameters ---------- diff --git a/pygmt/src/sph2grd.py b/pygmt/src/sph2grd.py index 1c32d422a61..72b3c3769b0 100644 --- a/pygmt/src/sph2grd.py +++ b/pygmt/src/sph2grd.py @@ -42,8 +42,8 @@ def sph2grd( - I = spacing - R = region - V = verbose - - r = registration - i = incols + - r = registration - x = cores Parameters