Skip to content

DOC: Remove the list of aliases and 'full option link' if all functionalities are implemented? #3881

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
seisman opened this issue Mar 29, 2025 · 6 comments
Labels
maintenance Boring but important stuff for the core devs
Milestone

Comments

@seisman
Copy link
Member

seisman commented Mar 29, 2025

Taking pygmt.grdfill as an example. Currently, all the options and functionalities are implemented (except -Lp but see #3768 for the reason). In this case, perhaps we can remove the "full option" link and the list of aliases, i.e., removing the following part:

Image

@seisman seisman added the discussions Need more discussion before taking further actions label Mar 29, 2025
@seisman
Copy link
Member Author

seisman commented Apr 2, 2025

@GenericMappingTools/pygmt-maintainers 👍 or 👎 ?

@yvonnefroehlich
Copy link
Member

I think the alias list can be still useful for users coming from GMT.

@yvonnefroehlich
Copy link
Member

Regarding the link to the GMT documentation: I personally used it, but not sure how often users have a look at the upstream docs. I am wondering if we can rename it to something like "GMT documentation at ..."?

@seisman
Copy link
Member Author

seisman commented Apr 2, 2025

I think the alias list can be still useful for users coming from GMT.

The alias will be incomplete and make little sense once we implement the new alias system (PR #3238) which maps multiple PyGMT parameters into one single GMT option. We can revisit the issue when we finish the new alias system.

Regarding the link to the GMT documentation: I personally used it, but not sure how often users have a look at the upstream docs. I am wondering if we can rename it to something like "GMT documentation at ..."?

What about changing it to "This function wraps the GMT module grdfill and the GMT documentation is at ..."?

@yvonnefroehlich
Copy link
Member

Regarding the link to the GMT documentation: I personally used it, but not sure how often users have a look at the upstream docs. I am wondering if we can rename it to something like "GMT documentation at ..."?

What about changing it to "This function wraps the GMT module grdfill and the GMT documentation is at ..."?

Sounds good!

@ezevazquez
Copy link

I personally think the alias list still adds value, particularly for GMT users who are looking for a one-to-one mapping. Even if the new alias system eventually replaces it, having both in the short term might help ease the transition.

I’d vote for keeping the alias list for now, and maybe just rewording the link to say something like > "For the complete GMT documentation, see..."

@seisman seisman added maintenance Boring but important stuff for the core devs and removed discussions Need more discussion before taking further actions labels May 24, 2025
@seisman seisman added this to the 0.16.0 milestone May 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Boring but important stuff for the core devs
Projects
None yet
Development

No branches or pull requests

3 participants