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.

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 2 commits into
base: main
Choose a base branch
from
Open

Conversation

seisman
Copy link
Member

@seisman seisman commented May 10, 2025

@seisman seisman added documentation Improvements or additions to documentation skip-changelog Skip adding Pull Request to changelog needs review This PR has higher priority and needs review. labels May 10, 2025
@seisman
Copy link
Member Author

seisman commented May 10, 2025

I'll apply the same changes to other wrappers if approved.

Copy link
Member

@yvonnefroehlich yvonnefroehlich left a 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.

@seisman
Copy link
Member Author

seisman commented May 11, 2025

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.

@seisman seisman added this to the 0.16.0 milestone May 12, 2025
Comment on lines 128 to 132
.. note::

Wraps the GMT module ``grdfill``.
The GMT documentation is 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.

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

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>`.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation needs review This PR has higher priority and needs review. skip-changelog Skip adding Pull Request to changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants