Skip to content

Commit 58123a7

Browse files
Add docstring for position parameter
1 parent 1cb524c commit 58123a7

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

pygmt/src/pygmtlogo.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -296,7 +296,18 @@ def pygmtlogo( # noqa: PLR0913
296296
Set the width of the logo.
297297
hight
298298
Set the hight of the logo.
299-
$position
299+
position
300+
Position of the GMT logo on the plot. It can be specified in multiple ways:
301+
302+
- A :class:`pygmt.params.Position` object to fully control the reference point,
303+
anchor point, and offset.
304+
- A sequence of two values representing the x- and y-coordinates in plot
305+
coordinates, e.g., ``(1, 2)`` or ``("1c", "2c")``.
306+
- A :doc:`2-character justification code </techref/justification_codes>` for a
307+
position inside the plot, e.g., ``"TL"`` for Top Left corner inside the plot.
308+
309+
If not specified, defaults to the Bottom Left corner of the plot (position
310+
``(0, 0)`` with anchor ``"BL"``).
300311
box
301312
Add a box around the logo.
302313
$verbose

0 commit comments

Comments
 (0)