Skip to content

Recommend Figure.timestamp and remove timestamp (U) alias from all plotting methods #2135

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 14 commits into from
Mar 5, 2023
Merged

Recommend Figure.timestamp and remove timestamp (U) alias from all plotting methods #2135

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
1024424
Remove timestamp (U) alias from all plotting methods
seisman Sep 24, 2022
80a2ac4
Update pygmt/helpers/decorators.py
seisman Nov 5, 2022
4f46fa9
Update pygmt/helpers/decorators.py
seisman Nov 5, 2022
9c587cb
Merge the main branch
seisman Nov 28, 2022
41b7f34
Fix a typo
seisman Nov 29, 2022
fb3ce91
Merge branch 'main' into remove-timestamp
seisman Nov 29, 2022
a55a7f4
Merge branch 'main' into remove-timestamp
seisman Mar 2, 2023
d62dcd2
Remove timestamps
seisman Mar 2, 2023
babf817
Merge branch 'main' into remove-timestamp
seisman Mar 3, 2023
9604e27
Add a unit test to make sure that old syntax are still supported
seisman Mar 3, 2023
87ded01
Fix linting issue
seisman Mar 3, 2023
3733354
Update pygmt/tests/test_timestamp.py
seisman Mar 3, 2023
9422326
Fix the minor differences in image dimensions
seisman Mar 3, 2023
6243cd0
Merge branch 'main' into remove-timestamp
seisman Mar 5, 2023
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: 11 additions & 0 deletions pygmt/helpers/decorators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -575,6 +575,17 @@ def new_module(*args, **kwargs):
f"Use long-form parameter '{long_alias}' instead."
)
warnings.warn(msg, category=SyntaxWarning, stacklevel=2)

# timestamp (U) is deprecated since v0.8.0.
Comment thread
seisman marked this conversation as resolved.
Outdated
if "U" in kwargs or "timestamp" in kwargs:
if "timestamp" in kwargs:
kwargs["U"] = kwargs.pop("timestamp")
msg = (
"Parameter 'U' and 'timestamp' is deprecated since v0.8.0. "
"Use Figure.timestamp() instead."
Comment thread
seisman marked this conversation as resolved.
Outdated
)
warnings.warn(msg, category=SyntaxWarning, stacklevel=2)

return module_func(*args, **kwargs)

new_module.aliases = aliases
Expand Down
2 changes: 0 additions & 2 deletions pygmt/src/basemap.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
F="box",
Td="rose",
Tm="compass",
U="timestamp",
V="verbose",
X="xshift",
Y="yshift",
Expand Down Expand Up @@ -82,7 +81,6 @@ def basemap(self, **kwargs):
compass : str
Draws a map magnetic rose on the map at the location defined by the
reference and anchor points
{timestamp}
{verbose}
{xyshift}
{panel}
Expand Down