Skip to content

Commit 56eff41

Browse files
Figure.timestamp: Simplify the docstrings for parameter 'justify' (#4106)
Co-authored-by: Yvonne Fröhlich <94163266+yvonnefroehlich@users.noreply.github.com>
1 parent f1328ca commit 56eff41

File tree

1 file changed

+9
-11
lines changed

1 file changed

+9
-11
lines changed

pygmt/src/timestamp.py

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,12 @@ def timestamp(
2626
r"""
2727
Plot the GMT timestamp logo.
2828
29-
Add the GMT timestamp logo with an optional label at the bottom-left corner of a
30-
plot with an offset of ``("-54p", "-54p")``. The timestamp will be in the locale set
31-
by the environment variable :term:`TZ` (generally local time but can be changed via
32-
``os.environ["TZ"]``) and its format is controlled by the ``timefmt`` parameter. It
33-
can also be replaced with any custom text string using the ``text`` parameter.
29+
Add the GMT timestamp logo with an optional label at the bottom-left corner relative
30+
to the current plot origin, with an offset of ``("-54p", "-54p")``. The timestamp
31+
will be in the locale set by the environment variable :term:`TZ` (generally local
32+
time but can be changed via ``os.environ["TZ"]``) and its format is controlled by
33+
the ``timefmt`` parameter. It can also be replaced with any custom text string using
34+
the ``text`` parameter.
3435
3536
Parameters
3637
----------
@@ -41,12 +42,9 @@ def timestamp(
4142
label
4243
The text string shown after the GMT timestamp logo.
4344
justify
44-
Justification of the timestamp box relative to the plot's bottom-left corner
45-
(i.e., the plot origin). Give a two-character code that is a combination of a
46-
horizontal (**L**\ (eft), **C**\ (enter), or **R**\ (ight)) and a vertical
47-
(**T**\ (op), **M**\ (iddle), or **B**\ (ottom)) code. For example,
48-
``justify="TL"`` means choosing the **T**\ op **L**\ eft point of the timestamp
49-
as the anchor point.
45+
Specify a :doc:`2-character justification code </techref/justification_codes>`
46+
for the timestamp box relative to the current plot origin. The default is the
47+
Bottom Left (``"BL"``) corner.
5048
offset
5149
*offset* or (*offset_x*, *offset_y*).
5250
Offset the anchor point of the timestamp box by *offset_x* and *offset_y*. If a

0 commit comments

Comments
 (0)