Merge branch 'main' into refactor/legend

Author: seisman

.github/ISSUE_TEMPLATE/5-bump_gmt_checklist.md

@@ -31,6 +31,7 @@ mamba install -c conda-forge gmt=X.Y.Z
 - [ ] Run `grep -r "# TODO(GMT.*)" --include="*.py" .` to find TODO items related to GMT
   - [ ] Remove related workarounds/patches
   - [ ] Fix tests with pytest `xfail`/`skipif` markers that now pass
+- [ ] Update URLs to manually inserted images of the GMT documentation
 - [ ] Update this checklist if necessary
 
 **To-Do for bumping the minimum required GMT version**:

.github/workflows/benchmarks.yml

@@ -84,7 +84,7 @@ jobs:
 
       # Run the benchmark tests
       - name: Run benchmarks
-        uses: CodSpeedHQ/action@6a8e2b874c338bf81cc5e8be715ada75908d3871 # v4.3.4
+        uses: CodSpeedHQ/action@346a2d8a8d9d38909abd0bc3d23f773110f076ad # v4.4.1
         with:
           mode: "instrumentation"
           # 'bash -el -c' is needed to use the custom shell.

.github/workflows/ci_tests.yaml

@@ -151,7 +151,7 @@ jobs:
           GH_TOKEN: ${{ github.token }}
 
       - name: Install uv
-        uses: astral-sh/setup-uv@1e862dfacbd1d6d858c55d9b792c756523627244 # v7.1.4
+        uses: astral-sh/setup-uv@681c641aba71e4a1c380be3ab5e12ad51f415867 # v7.1.6
         with:
           activate-environment: true
           python-version: ${{ matrix.python-version }}

doc/contributing.md

@@ -488,10 +488,10 @@ integration systems will warn us and you can make a new commit with the formatte
 Even better, you can just write `/format` in the first line of any comment in a
 pull request to lint the code automatically.
 
-When wrapping a new alias, use an underscore to separate words bridged by vowels
-(aeiou), such as `no_skip` and `z_only`. Do not use an underscore to separate
-words bridged only by consonants, such as `distcalc`, and `crossprofile`. This
-convention is not applied by the code checking tools, but the PyGMT maintainers
+When introducing a new parameter name, use an underscore to separate words. This improves
+readability and aligns with the [PEP 8 style guide](https://peps.python.org/pep-0008/).
+For common shortcuts no underscore is needed, e.g., `surftype`, `outgrid`, or `timefmt`.
+This convention is not applied by the code checking tools, but the PyGMT maintainers
 will comment on any pull requests as needed.
 
 When working on a tutorial or a gallery plot, it is good practice to use code

examples/gallery/embellishments/gmt_logo.py

@@ -7,12 +7,12 @@
 
 # %%
 import pygmt
+from pygmt.params import Position
 
 fig = pygmt.Figure()
 fig.basemap(region=[0, 10, 0, 2], projection="X6c", frame=True)
 
 # Add the GMT logo in the Top Right (TR) corner of the current plot, scaled up to be 3
 # centimeters wide and offset by 0.3 cm in x-direction and 0.6 cm in y-direction.
-fig.logo(position="jTR+o0.3c/0.6c+w3c")
-
+fig.logo(position=Position("TR", offset=(0.3, 0.6)), width="3c")
 fig.show()

examples/projections/cyl/cyl_universal_transverse_mercator.py

@@ -14,7 +14,7 @@
 
 .. _GMT_utm_zones:
 
-.. figure:: https://docs.generic-mapping-tools.org/latest/_images/GMT_utm_zones.png
+.. figure:: https://docs.generic-mapping-tools.org/6.6/_images/GMT_utm_zones.png
    :width: 700 px
    :align: center
 

examples/tutorials/advanced/cartesian_histograms.py

@@ -320,7 +320,7 @@
 # Grouped bars
 # ------------
 #
-# By setting the ``barwidth`` parameter in respect to the values passed to the
+# By setting the ``bar_width`` parameter in respect to the values passed to the
 # ``series`` parameter histograms with grouped bars can be created.
 #
 # Limitations of histograms with grouped bars are:
@@ -347,7 +347,7 @@
     # of the bin width
     # Offset ("+o") the bars to align each bar with the left limit of the corresponding
     # bin
-    barwidth=f"{binwidth / 2}+o-{binwidth / 4}",
+    bar_width=f"{binwidth / 2}+o-{binwidth / 4}",
     label="data01",
 )
 
@@ -358,7 +358,7 @@
     fill="orange",
     pen="1p,darkgray,solid",
     histtype=0,
-    barwidth=f"{binwidth / 2}+o{binwidth / 4}",
+    bar_width=f"{binwidth / 2}+o{binwidth / 4}",
     label="data02",
 )
 

pygmt/encodings.py

@@ -16,7 +16,7 @@
 ----------
 
 - GMT-octal-codes: https://github.com/seisman/GMT-octal-codes
-- GMT documentation: https://docs.generic-mapping-tools.org/dev/reference/octal-codes.html
+- GMT documentation: https://docs.generic-mapping-tools.org/6.6/reference/octal-codes.html
 - Adobe Postscript Language Reference: https://www.adobe.com/jp/print/postscript/pdfs/PLRM.pdf
 - Adobe ISOLatin1+: https://en.wikipedia.org/wiki/PostScript_Latin_1_Encoding
 - Adobe Symbol: https://en.wikipedia.org/wiki/Symbol_(typeface)

pygmt/params/pattern.py

@@ -26,7 +26,7 @@ class Pattern(BaseParam):
     GMT provides 90 predefined patterns that can be used in PyGMT. The patterns are
     numbered from 1 to 90, and shown below:
 
-    .. figure:: https://docs.generic-mapping-tools.org/6.5/_images/GMT_App_E.png
+    .. figure:: https://docs.generic-mapping-tools.org/6.6/_images/GMT_App_E.png
        :alt: The 90 predefined bit-patterns provided with GMT
        :width: 75%
        :align: center

pygmt/params/position.py

@@ -18,7 +18,7 @@ class Position(BaseParam):
     """
     Class for positioning embellishments on a plot.
 
-    .. figure:: https://docs.generic-mapping-tools.org/dev/_images/GMT_anchor.png
+    .. figure:: https://docs.generic-mapping-tools.org/6.6/_images/GMT_anchor.png
        :width: 600 px
        :align: center