Merge branch 'main' into add-tut-legend-l

Author: yvonnefroehlich

.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/3d_plots/GALLERY_HEADER.rst

@@ -1,2 +1,2 @@
-3D Plots
---------
+3-D Plots
+---------

examples/gallery/basemaps/double_y_axes.py

@@ -20,6 +20,7 @@ class can control which axes should be plotted and optionally show annotations,
 # %%
 import numpy as np
 import pygmt
+from pygmt.params import Position
 
 # Generate two sample Y-data from one common X-data
 x = np.linspace(1.0, 9.0, num=9)
@@ -63,8 +64,7 @@ class can control which axes should be plotted and optionally show annotations,
 # Plot points for y2-data
 fig.plot(x=x, y=y2, style="s0.28c", fill="red", label="y2")
 
-# Create a legend in the Top Left (TL) corner of the plot with an
-# offset of 0.1 centimeters
-fig.legend(position="jTL+o0.1c", box=True)
+# Create a legend in the Top Left (TL) corner of the plot with a 0.1-cm offset.
+fig.legend(position=Position("TL", offset=0.1), box=True)
 
 fig.show()

examples/gallery/basemaps/ternary.py

@@ -8,7 +8,7 @@
 at the positions listed in the first three columns of the sample dataset
 ``rock_compositions``, with default annotations and gridline spacings, using
 the specified labeling defined via ``alabel``, ``blabel``, and ``clabel``.
-Points are colored based on the values given in the fourth columns of the
+Points are colored based on the values given in the fourth column of the
 sample dataset via ``cmap=True``.
 """
 

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/gallery/embellishments/inset.py

@@ -3,9 +3,9 @@
 =====
 
 The :meth:`pygmt.Figure.inset` method adds an inset figure inside a larger
-figure. The method is called using a ``with`` statement, and its
-``position``, ``box``, ``offset``, and ``margin`` parameters are set. Plotting
-methods called within the ``with`` statement are applied to the inset figure.
+figure. The method is called using a ``with`` statement, and its ``position``,
+``box``, ``offset``, and ``clearance`` parameters are set. Plotting methods
+called within the ``with`` statement are applied to the inset figure.
 """
 
 # %%
@@ -18,9 +18,9 @@
 # adding a frame
 fig.coast(region="MG+r2", land="brown", water="lightblue", shorelines="thin", frame="a")
 # Create an inset, placing it in the Top Left (TL) corner with a width of 3.5 cm and
-# x- and y-offsets of 0.2 cm. The margin is set to 0, and the border is "gold" with a
+# x- and y-offsets of 0.2 cm. The clearance is set to 0, and the border is "gold" with a
 # pen size of 1.5 points.
-with fig.inset(position="jTL+w3.5c+o0.2c", margin=0, box=Box(pen="1.5p,gold")):
+with fig.inset(position="jTL+w3.5c+o0.2c", clearance=0, box=Box(pen="1.5p,gold")):
     # Create a figure in the inset using coast. This example uses the azimuthal
     # orthogonal projection centered at 47E, 20S. The land color is set to
     # "gray" and Madagascar is highlighted in "red3".

examples/gallery/embellishments/inset_rectangle_region.py

@@ -3,9 +3,9 @@
 ======================================
 
 The :meth:`pygmt.Figure.inset` method adds an inset figure inside a larger
-figure. The method is called using a ``with`` statement, and its
-``position``, ``box``, ``offset``, and ``margin`` can be customized. Plotting
-methods called within the ``with`` statement plot into the inset figure.
+figure. The method is called using a ``with`` statement, and its ``position``,
+``box``, ``offset``, and ``clearance`` can be customized. Plotting methods
+called within the ``with`` statement plot into the inset figure.
 """
 
 # %%