pygmt.set_display: Do nothing when the display method is set to 'none' (

#2450)

pygmt/figure.py

@@ -393,7 +393,7 @@ def show(self, dpi=300, width=500, method=None, waiting=0.5, **kwargs):
                 )
             )
 
-        if method in ["notebook", "none"]:
+        if method == "notebook":
             if IPython is None:
                 raise GMTError(
                     (

pygmt/src/coast.py

@@ -200,7 +200,6 @@ def coast(self, **kwargs):
     ... )
     >>> # Show the plot
     >>> fig.show()
-    <IPython.core.display.Image object>
     """
     kwargs = self._preprocess(**kwargs)  # pylint: disable=protected-access
     if not args_in_kwargs(args=["C", "G", "S", "I", "N", "E", "Q", "W"], kwargs=kwargs):

pygmt/src/grd2cpt.py

@@ -175,7 +175,6 @@ def grd2cpt(grid, **kwargs):
     >>> fig.grdimage(grid=grid)
     >>> # show the plot
     >>> fig.show()
-    <IPython.core.display.Image object>
     """
     if kwargs.get("W") is not None and kwargs.get("Ww") is not None:
         raise GMTInvalidInput("Set only categorical or cyclic to True, not both.")

pygmt/src/grdcontour.py

@@ -120,7 +120,6 @@ def grdcontour(self, grid, **kwargs):
     ... )
     >>> # show the plot
     >>> fig.show()
-    <IPython.core.display.Image object>
     """
     kwargs = self._preprocess(**kwargs)  # pylint: disable=protected-access
     with Session() as lib:

pygmt/src/grdimage.py

@@ -173,7 +173,6 @@ def grdimage(self, grid, **kwargs):
     >>> fig.grdimage(grid=grid, cmap="geo", projection="W10c", frame="ag")
     >>> # show the plot
     >>> fig.show()
-    <IPython.core.display.Image object>
     """
     kwargs = self._preprocess(**kwargs)  # pylint: disable=protected-access
     with Session() as lib:

pygmt/src/inset.py

@@ -130,8 +130,7 @@ def inset(self, **kwargs):
     ...
     >>> # Map elements outside the "with" block are plotted in the main figure
     >>> fig.logo(position="jBR+o0.2c+w3c")
-    >>> fig.show()  # doctest: +SKIP
-    <IPython.core.display.Image object>
+    >>> fig.show()
     """
     kwargs = self._preprocess(**kwargs)  # pylint: disable=protected-access
     with Session() as lib:

pygmt/src/solar.py

@@ -87,7 +87,6 @@ def solar(self, terminator="d", terminator_datetime=None, **kwargs):
     ... )
     >>> # show the plot
     >>> fig.show()
-    <IPython.core.display.Image object>
     """
 
     kwargs = self._preprocess(**kwargs)  # pylint: disable=protected-access

pygmt/src/timestamp.py

@@ -68,13 +68,11 @@ def timestamp(
     >>> fig = pygmt.Figure()
     >>> fig.timestamp()
     >>> fig.show()
-    <IPython.core.display.Image object>
 
     >>> # Plot the GMT timestamp logo with a custom label.
     >>> fig = pygmt.Figure()
     >>> fig.timestamp(label="Powered by PyGMT")
     >>> fig.show()
-    <IPython.core.display.Image object>
     """
     self._preprocess()  # pylint: disable=protected-access