-
Notifications
You must be signed in to change notification settings - Fork 229
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.
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
base: main
Are you sure you want to change the base?
Conversation
I'll apply the same changes to other wrappers if approved. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For me this change looks good in the docs.
Ping @michaelgrund and @weiji14 for comments before I make changes. Actually, I'd still like to rephrase the sentence so the links appear on one line, but I haven’t found a good solution yet. |
pygmt/src/grdfill.py
Outdated
.. note:: | ||
|
||
Wraps the GMT module ``grdfill``. | ||
The GMT documentation is at :gmt-docs:`grdfill.html`. | ||
|
There was a problem hiding this comment.
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.
.. 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`). | |
There was a problem hiding this comment.
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?
.. 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`. |
There was a problem hiding this comment.
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)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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:
- https://www.pygmt.org/v0.15.0/api/generated/pygmt.Figure.set_panel.html (upstream uses
gmt subplot set
), and that page is missing the upstream doc link btw. - https://www.pygmt.org/dev/api/generated/pygmt.which.html#pygmt.which (upstream uses
gmtwhich
)
The names seem to follow closely enough that we don't need to repeat the name really.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Address #3881.
For comparison: