From 9aa8f97fde9d028a8d85e80085509e91a88ea5b8 Mon Sep 17 00:00:00 2001 From: Dongdong Tian Date: Thu, 2 Jan 2025 18:57:31 +0800 Subject: [PATCH] Add a note about the bug in GMT<=6.5.0 --- pygmt/src/plot.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/pygmt/src/plot.py b/pygmt/src/plot.py index 8c6d014952a..23c5bde12fd 100644 --- a/pygmt/src/plot.py +++ b/pygmt/src/plot.py @@ -114,7 +114,8 @@ def plot( along such arcs) in the geographic coordinate system. The ``straight_line`` parameter can control the drawing of line segments. Valid values are: - - ``True``: Draw line segments as straight lines in geographic projections. + - ``True``: Draw line segments as straight lines in geographic coordinate + systems. - ``"x"``: Draw line segments by first along *x*, then along *y*. - ``"y"``: Draw line segments by first along *y*, then along *x*. @@ -124,6 +125,12 @@ def plot( - **Polar** coordinate system: *x* and *y* are theta and radius. - **Geographic** coordinate system: *x* and *y* are parallels and meridians. + .. attention:: + + There exits a bug in GMT<=6.5.0 that, in geographic coordinate systems, the + meaning of *x* and *y* is reversed, i.e., *x* means meridians and *y* means + parallels. The bug is fixed by upstream + `PR #8648 `__. {frame} {cmap} offset : str @@ -220,6 +227,8 @@ def plot( ``x``/``y``. {wrap} """ + # TODO(GMT>6.5.0): Remove the note for the upstream bug of the "straight_line" + # parameter. kwargs = self._preprocess(**kwargs) kind = data_kind(data)