-
Notifications
You must be signed in to change notification settings - Fork 228
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
Comments
@GenericMappingTools/pygmt-maintainers 👍 or 👎 ? |
I think the alias list can be still useful for users coming from GMT. |
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 ..."? |
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.
What about changing it to "This function wraps the GMT module |
Sounds good! |
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..." |
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:The text was updated successfully, but these errors were encountered: