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

Merged
seisman merged 9 commits into from
May 24, 2025
Merged

DOC: Improve link to the GMT documentation #3944

Changes from 1 commit
Commits
Show all changes
9 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
bc4bca5
Merge branch 'main' into doc/alias-link
seisman May 17, 2025
001a066
Merge branch 'main' into doc/alias-link
seisman May 20, 2025
23853e4
Merge branch 'main' into doc/alias-link
seisman May 22, 2025
8cd4d3c
Shorter version
seisman May 22, 2025
c53f2c9
Rephrase 'Full option list at' to 'Full GMT docs at'
seisman May 24, 2025
d488f43
Merge branch 'main' into doc/alias-link
seisman May 24, 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
7 changes: 5 additions & 2 deletions pygmt/src/grdfill.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,14 +125,17 @@ def grdfill(
r"""
Interpolate across holes in a grid.

.. note::

Wraps the GMT module ``grdfill``.
The GMT documentation is at :gmt-docs:`grdfill.html`.

Copy link
Member

@yvonnefroehlich yvonnefroehlich May 12, 2025

Choose a reason for hiding this comment

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

Hm. If it should fit into one line, maye we can put the link to the docs within the grdfill.
Not sure, if the link works in this way or the full URL is required.

Suggested change
.. note::
Wraps the GMT module ``grdfill``.
The GMT documentation is at :gmt-docs:`grdfill.html`.
.. note::
Wraps the GMT module [``grdfill``](:gmt-docs:`grdfill.html`).

Copy link
Member Author

@seisman seisman May 12, 2025

Choose a reason for hiding this comment

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

I'm not sure if your solution works, but the one below is shorter and should work. This way, the URL isn't explicitly shown, so readers might not realize that it links to the GMT documentation. Is it OK?

Suggested change
.. note::
Wraps the GMT module ``grdfill``.
The GMT documentation is at :gmt-docs:`grdfill.html`.
Wraps the GMT module :gmt-docs:`grdfill <grdfill.html>`.

Read a grid that presumably has unfilled holes that the user wants to fill in some
fashion. Holes are identified by NaN values but this criteria can be changed via the
``hole`` parameter. There are several different algorithms that can be used to
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

@weiji14 weiji14 May 14, 2025

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

@seisman seisman May 14, 2025

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

@weiji14 weiji14 May 14, 2025

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.

Copy link
Member

@weiji14 weiji14 May 22, 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.

For those convenience methods, then yes, it makes sense to use "Wraps GMT module scatter, with full docs at :gmt-docs:plot.html". But for most other ones, probably ok to use just "Full GMT docs at ..."?

Copy link
Member Author

@seisman seisman May 22, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

OK. I've changed it to "Full GMT docs at ...". Will apply the same changes to other files when getting at least two approvals.

Edit: I've applied the changes to all files.


{aliases}

Parameters
Expand Down