Skip to content

DOC: Improve link to the GMT documentation #3944

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

DOC: Improve link to the GMT documentation #3944

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
86d731a
DOC: Improve link to the GMT documentation.
seisman May 10, 2025
f6fd3e9
Use shorter version.
seisman May 12, 2025
fbe8b0b
New style
seisman May 14, 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
2 changes: 1 addition & 1 deletion pygmt/src/grdfill.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ def grdfill(
replace the hole values. If no holes are found the original unchanged grid is
returned.

Full option list at :gmt-docs:`grdfill.html`.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The note:: admonition stands out a bit too much. Perhaps just reword Full option list at ... to Full GMT docs at ..., similar to @ezevazquez's suggestion at #3881 (comment)?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The note:: admonition stands out a bit too much.

I agree.

Perhaps just reword Full option list at ... to Full GMT docs at ...

I prefer to explicitly mention the name of the GMT module, since the function/method names may differ from the module names. What about the one below?

image

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

since the function/method names may differ from the module names

I thought we usually use the same method name as upstream GMT? Different ones I can find are:

The names seem to follow closely enough that we don't need to repeat the name really.

Copy link
Member Author

@seisman seisman May 14, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have methods like hlines/vlines and will have methods like scatter (#3602 ) and choropleth (#2798), which wrap plot. I guess we still need to link to plot in these methods.

Wraps GMT module ``grdfill``, with full docs at :gmt-docs:`grdfill.html`.

{aliases}

Expand Down