From a755122c0eb09afc200896841afff4f1519d4f10 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 18 Jun 2026 14:30:18 +0800 Subject: [PATCH 1/4] Figure.plot: Document the high-level wrappers in the docstrings --- pygmt/src/plot.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/pygmt/src/plot.py b/pygmt/src/plot.py index a661d3efd3b..6e08e207239 100644 --- a/pygmt/src/plot.py +++ b/pygmt/src/plot.py @@ -86,6 +86,17 @@ def plot( # noqa: PLR0912, PLR0913 Full GMT docs at :gmt-docs:`plot.html`. + See Also + -------- + pygmt.Figure.choropleth + Plot a choropleth map. + pygmt.Figure.hlines + Plot horizontal lines. + pygmt.Figure.vlines + Plot vertical lines. + pygmt.Figure.fill_between + Fill the area between two curves. + $aliases - A = straight_line - B = frame From 12ca21bd609f0a5a4a91662bd5ac02342aa20ce5 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Sat, 20 Jun 2026 12:15:50 +0800 Subject: [PATCH 2/4] Move seealso after aliases --- pygmt/src/plot.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/pygmt/src/plot.py b/pygmt/src/plot.py index 6e08e207239..6692dde3199 100644 --- a/pygmt/src/plot.py +++ b/pygmt/src/plot.py @@ -86,17 +86,6 @@ def plot( # noqa: PLR0912, PLR0913 Full GMT docs at :gmt-docs:`plot.html`. - See Also - -------- - pygmt.Figure.choropleth - Plot a choropleth map. - pygmt.Figure.hlines - Plot horizontal lines. - pygmt.Figure.vlines - Plot vertical lines. - pygmt.Figure.fill_between - Fill the area between two curves. - $aliases - A = straight_line - B = frame @@ -108,6 +97,17 @@ def plot( # noqa: PLR0912, PLR0913 - p = perspective - t = transparency + See Also + -------- + pygmt.Figure.choropleth + Plot a choropleth map. + pygmt.Figure.hlines + Plot horizontal lines. + pygmt.Figure.vlines + Plot vertical lines. + pygmt.Figure.fill_between + Fill the area between two curves. + Parameters ---------- data From eb405fc01ad489b193b3ca9200cb8e32027013a6 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 22 Jun 2026 13:08:27 +0800 Subject: [PATCH 3/4] Move seealso to the end --- pygmt/src/plot.py | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/pygmt/src/plot.py b/pygmt/src/plot.py index 6692dde3199..3209d74e412 100644 --- a/pygmt/src/plot.py +++ b/pygmt/src/plot.py @@ -97,17 +97,6 @@ def plot( # noqa: PLR0912, PLR0913 - p = perspective - t = transparency - See Also - -------- - pygmt.Figure.choropleth - Plot a choropleth map. - pygmt.Figure.hlines - Plot horizontal lines. - pygmt.Figure.vlines - Plot vertical lines. - pygmt.Figure.fill_between - Fill the area between two curves. - Parameters ---------- data @@ -247,6 +236,17 @@ def plot( # noqa: PLR0912, PLR0913 ``transparency`` can also be a 1-D array to set varying transparency for symbols, but this option is only valid if using ``x``/``y``. $wrap + + See Also + -------- + pygmt.Figure.choropleth + Plot a choropleth map. + pygmt.Figure.hlines + Plot horizontal lines. + pygmt.Figure.vlines + Plot vertical lines. + pygmt.Figure.fill_between + Fill the area between two curves. """ # TODO(GMT>6.5.0): Remove the note for the upstream bug of the "straight_line" # parameter. From e7d75ebc40c95974d54852f62cfb1df8328cd3ea Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Mon, 22 Jun 2026 13:14:25 +0800 Subject: [PATCH 4/4] Add more high-level wrappers --- pygmt/src/basemap.py | 9 +++++++++ pygmt/src/coast.py | 9 +++++++++ pygmt/src/plot.py | 4 ++-- pygmt/src/text.py | 5 +++++ 4 files changed, 25 insertions(+), 2 deletions(-) diff --git a/pygmt/src/basemap.py b/pygmt/src/basemap.py index 4dbec079178..b2ebcc84504 100644 --- a/pygmt/src/basemap.py +++ b/pygmt/src/basemap.py @@ -124,6 +124,15 @@ def basemap( # noqa: PLR0913 $perspective $transparency + See Also + -------- + pygmt.Figure.directional_rose + Add a map directional rose. + pygmt.Figure.magnetic_rose + Add a map magnetic rose. + pygmt.Figure.scalebar + Add a scale bar. + Examples -------- >>> import pygmt diff --git a/pygmt/src/coast.py b/pygmt/src/coast.py index 5bb72a14d41..e359f28662a 100644 --- a/pygmt/src/coast.py +++ b/pygmt/src/coast.py @@ -208,6 +208,15 @@ def coast( # noqa: PLR0913 $perspective $transparency + See Also + -------- + pygmt.Figure.directional_rose + Add a map directional rose. + pygmt.Figure.magnetic_rose + Add a map magnetic rose. + pygmt.Figure.scalebar + Add a scale bar. + Example ------- >>> import pygmt diff --git a/pygmt/src/plot.py b/pygmt/src/plot.py index 3209d74e412..2900296d7f7 100644 --- a/pygmt/src/plot.py +++ b/pygmt/src/plot.py @@ -241,12 +241,12 @@ def plot( # noqa: PLR0912, PLR0913 -------- pygmt.Figure.choropleth Plot a choropleth map. + pygmt.Figure.fill_between + Fill the area between two curves. pygmt.Figure.hlines Plot horizontal lines. pygmt.Figure.vlines Plot vertical lines. - pygmt.Figure.fill_between - Fill the area between two curves. """ # TODO(GMT>6.5.0): Remove the note for the upstream bug of the "straight_line" # parameter. diff --git a/pygmt/src/text.py b/pygmt/src/text.py index 271d79da1ee..5d747299d89 100644 --- a/pygmt/src/text.py +++ b/pygmt/src/text.py @@ -187,6 +187,11 @@ def text( # noqa: PLR0912, PLR0913, PLR0915 ``transparency`` can also be a 1-D array to set varying transparency for texts, but this option is only valid if using ``x``/``y`` and ``text``. $wrap + + See Also + -------- + pygmt.Figure.paragarph + Typeset one or multiple paragraphs. """ self._activate_figure()