Merge branch 'main' into update-common-strings

Author: Meghan Jones

pygmt/sphinx_gallery.py

@@ -1,11 +1,8 @@
 """
 Utilities for using pygmt with sphinx-gallery.
 """
-try:
-    from sphinx_gallery.scrapers import figure_rst
-except ImportError:
-    figure_rst = None
 
+import sphinx_gallery.scrapers
 from pygmt.figure import SHOWED_FIGURES
 
 
@@ -32,4 +29,4 @@ def __call__(self, block, block_vars, gallery_conf):
             fig = figures.pop(0)
             fig.savefig(fname, transparent=True, dpi=200)
             image_names.append(fname)
-        return figure_rst(image_names, gallery_conf["src_dir"])
+        return sphinx_gallery.scrapers.figure_rst(image_names, gallery_conf["src_dir"])

pygmt/src/blockm.py

@@ -81,7 +81,7 @@ def _blockm(block_method, table, outfile, x, y, z, **kwargs):
     r="registration",
     w="wrap",
 )
-@kwargs_to_strings(R="sequence", i="sequence_comma")
+@kwargs_to_strings(R="sequence", i="sequence_comma", o="sequence_comma")
 def blockmean(table=None, outfile=None, *, x=None, y=None, z=None, **kwargs):
     r"""
     Block average (x,y,z) data tables by mean estimation.
@@ -158,7 +158,7 @@ def blockmean(table=None, outfile=None, *, x=None, y=None, z=None, **kwargs):
     r="registration",
     w="wrap",
 )
-@kwargs_to_strings(R="sequence", i="sequence_comma")
+@kwargs_to_strings(R="sequence", i="sequence_comma", o="sequence_comma")
 def blockmedian(table=None, outfile=None, *, x=None, y=None, z=None, **kwargs):
     r"""
     Block average (x,y,z) data tables by median estimation.
@@ -241,7 +241,7 @@ def blockmedian(table=None, outfile=None, *, x=None, y=None, z=None, **kwargs):
     r="registration",
     w="wrap",
 )
-@kwargs_to_strings(R="sequence", i="sequence_comma")
+@kwargs_to_strings(R="sequence", i="sequence_comma", o="sequence_comma")
 def blockmode(table=None, outfile=None, *, x=None, y=None, z=None, **kwargs):
     r"""
     Block average (x,y,z) data tables by mode estimation.

pygmt/src/grdtrack.py

@@ -40,7 +40,7 @@
     s="skiprows",
     w="wrap",
 )
-@kwargs_to_strings(R="sequence", S="sequence", i="sequence_comma")
+@kwargs_to_strings(R="sequence", S="sequence", i="sequence_comma", o="sequence_comma")
 def grdtrack(points, grid, newcolname=None, outfile=None, **kwargs):
     r"""
     Sample grids at specified (x,y) locations.

pygmt/tests/test_sphinx_gallery.py

@@ -5,17 +5,13 @@
 from tempfile import TemporaryDirectory
 
 import pytest
-
-try:
-    import sphinx_gallery
-except ImportError:
-    sphinx_gallery = None
-
 from pygmt.figure import SHOWED_FIGURES, Figure
-from pygmt.sphinx_gallery import PyGMTScraper
+
+pygmt_sphinx_gallery = pytest.importorskip(
+    "pygmt.sphinx_gallery", reason="requires sphinx-gallery to be installed"
+)
 
 
-@pytest.mark.skipif(sphinx_gallery is None, reason="requires sphinx-gallery")
 def test_pygmtscraper():
     """
     Make sure the scraper finds the figures and removes them from the pool.
@@ -30,7 +26,7 @@ def test_pygmtscraper():
         fig.show()
         assert len(SHOWED_FIGURES) == 1
         assert SHOWED_FIGURES[0] is fig
-        scraper = PyGMTScraper()
+        scraper = pygmt_sphinx_gallery.PyGMTScraper()
         with TemporaryDirectory(dir=os.getcwd()) as tmpdir:
             conf = {"src_dir": "meh"}
             fname = os.path.join(tmpdir, "meh.png")