Skip to content

Commit fcee181

Browse files
committed
Remove the inline doctest because it's already covered in the gallery example
1 parent 6d3e2ef commit fcee181

File tree

1 file changed

+1
-32
lines changed

1 file changed

+1
-32
lines changed

pygmt/src/inset.py

Lines changed: 1 addition & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,6 @@
66
from pygmt.clib import Session
77
from pygmt.helpers import build_arg_string, fmt_docstring, kwargs_to_strings, use_alias
88

9-
__doctest_skip__ = ["inset"]
10-
11-
129
@fmt_docstring
1310
@contextlib.contextmanager
1411
@use_alias(
@@ -47,7 +44,7 @@ def inset(self, **kwargs):
4744
4845
Append **g**\ *lon*/*lat* for map (user) coordinates,
4946
**j**\ *code* or **J**\ *code* for setting the *refpoint* via a
50-
2-char justification code \ that refers to the (invisible)
47+
2-char justification code that refers to the (invisible)
5148
projected map bounding box, **n**\ *xn*/*yn* for normalized (0-1)
5249
bounding box coordinates, or **x**\ *x*/*y* for plot
5350
coordinates (inches, cm, points, append unit).
@@ -109,34 +106,6 @@ def inset(self, **kwargs):
109106
{R}
110107
{J}
111108
{V}
112-
113-
Examples
114-
--------
115-
>>> import pygmt
116-
>>>
117-
>>> # Create the larger figure
118-
>>> fig = pygmt.Figure()
119-
>>> fig.coast(region="MG+r2", water="lightblue", shorelines="thin")
120-
>>> # Use a "with" statement to initialize the inset context manager.
121-
>>> # Seting the position to top left with an 0.2 cm offset and
122-
>>> # draw a green inset box.
123-
>>> # The inset size is determined by the region and projection parameters.
124-
>>> with fig.inset(
125-
... position="jTL+o0.2c",
126-
... margin=0,
127-
... box="+pgreen",
128-
... region="g",
129-
... projection="G47/-20/3.5c",
130-
... ):
131-
... fig.coast(
132-
... land="gray",
133-
... water="white",
134-
... dcw="MG+gred",
135-
... )
136-
>>> # Map elements outside the "with" block are plotted in the main figure
137-
>>> fig.logo(position="jBR+o0.2c+w3c")
138-
>>> fig.show() # doctest: +SKIP
139-
<IPython.core.display.Image object>
140109
"""
141110
kwargs = self._preprocess(**kwargs) # pylint: disable=protected-access
142111
with Session() as lib:

0 commit comments

Comments
 (0)