Skip to content

Commit 4a9c09b

Browse files
Fix docstrings taken from helpers
1 parent 4bc9f68 commit 4a9c09b

1 file changed

Lines changed: 6 additions & 2 deletions

File tree

pygmt/src/pygmtlogo.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@
1010

1111
import numpy as np
1212
from pygmt._typing import AnchorCode, PathLike
13-
from pygmt.helpers import GMTTempFile
13+
from pygmt.helpers import (
14+
GMTTempFile,
15+
fmt_docstring,
16+
)
1417
from pygmt.params import Box, Position
1518

1619
__doctest_skip__ = ["pygmtlogo"]
@@ -249,6 +252,7 @@ def _vline_coords():
249252
fig.savefig(fname=figname)
250253

251254

255+
@fmt_docstring
252256
def pygmtlogo( # noqa: PLR0913
253257
self,
254258
shape: Literal["circle", "hexagon"] = "circle",
@@ -265,7 +269,7 @@ def pygmtlogo( # noqa: PLR0913
265269
perspective: float | Sequence[float] | str | bool = False,
266270
transparency: float | None = None,
267271
):
268-
"""
272+
r"""
269273
Plot the PyGMT logo.
270274
The design of the logo is kindly provided by `@sfrooti <https://github.com/sfrooti>`_
271275
and consists of a visual and the wordmark "PyGMT".

0 commit comments

Comments
 (0)