Skip to content

Figure.timestamp: Fix wording in docstrings #4478

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
seisman merged 2 commits into from
Apr 1, 2026
Merged

Figure.timestamp: Fix wording in docstrings #4478

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9cd87fb
Fix timestamp docstring wording
seisman Mar 29, 2026
0aef214
Merge branch 'main' into fix/timestamp-docstring
seisman Mar 30, 2026
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
11 changes: 6 additions & 5 deletions pygmt/src/timestamp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ def timestamp(
Parameters
----------
text
If ``None``, the current UNIX timestamp is shown in the GMT timestamp logo. Set
this parameter to replace the UNIX timestamp with a custom text string instead.
If ``None``, the current date and time are shown in the GMT timestamp logo. Set
this parameter to replace the timestamp string with a custom text string
instead.
The text must be no longer than 64 characters; longer strings are truncated and
raise a :class:`RuntimeWarning`.
label
Expand All @@ -54,9 +55,9 @@ def timestamp(
height, the font sizes are fixed to be 8-point for the timestamp and 7-point for
the label.
timefmt
Format string for the UNIX timestamp. The format string is parsed by the C
function ``strftime``, so that virtually any text can be used (even not
containing any time information).
Format string for the timestamp. The format string is parsed by the C function
``strftime``, so that virtually any text can be used (even not containing any
time information).

Examples
--------
Expand Down
Loading