Skip to content

Figure.timestamp: Simplify the docstrings for parameter 'justify' #4106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Sep 23, 2025
Merged

Figure.timestamp: Simplify the docstrings for parameter 'justify' #4106

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7dd3010
Figure.timestamp: Simplify the docstrings for parameter 'justify'
seisman Sep 20, 2025
fd710da
Fix typos
seisman Sep 20, 2025
1518ce7
Update pygmt/src/timestamp.py
seisman Sep 20, 2025
88d8223
Improve docstrings
seisman Sep 21, 2025
0512f2b
Merge branch 'main' into doc/timestamp
seisman Sep 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions pygmt/src/timestamp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,12 @@ def timestamp(
r"""
Plot the GMT timestamp logo.

Add the GMT timestamp logo with an optional label at the bottom-left corner of a
plot with an offset of ``("-54p", "-54p")``. The timestamp will be in the locale set
by the environment variable :term:`TZ` (generally local time but can be changed via
``os.environ["TZ"]``) and its format is controlled by the ``timefmt`` parameter. It
can also be replaced with any custom text string using the ``text`` parameter.
Add the GMT timestamp logo with an optional label at the bottom-left corner relative
to the current plot origin, with an offset of ``("-54p", "-54p")``. The timestamp
will be in the locale set by the environment variable :term:`TZ` (generally local
time but can be changed via ``os.environ["TZ"]``) and its format is controlled by
the ``timefmt`` parameter. It can also be replaced with any custom text string using
the ``text`` parameter.

Parameters
----------
Expand All @@ -41,12 +42,9 @@ def timestamp(
label
The text string shown after the GMT timestamp logo.
justify
Justification of the timestamp box relative to the plot's bottom-left corner
(i.e., the plot origin). Give a two-character code that is a combination of a
horizontal (**L**\ (eft), **C**\ (enter), or **R**\ (ight)) and a vertical
(**T**\ (op), **M**\ (iddle), or **B**\ (ottom)) code. For example,
``justify="TL"`` means choosing the **T**\ op **L**\ eft point of the timestamp
as the anchor point.
Specify a :doc:`2-character justification code </techref/justification_codes>`
for the timestamp box relative to the current plot origin. The default is the
Bottom Left (``"BL"``) corner.
offset
*offset* or (*offset_x*, *offset_y*).
Offset the anchor point of the timestamp box by *offset_x* and *offset_y*. If a
Expand Down
Loading