You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
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 ..."?
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 ..."?
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 ..."?
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..."
Activity
seisman commentedon Apr 2, 2025
@GenericMappingTools/pygmt-maintainers 👍 or 👎 ?
yvonnefroehlich commentedon Apr 2, 2025
I think the alias list can be still useful for users coming from GMT.
yvonnefroehlich commentedon Apr 2, 2025
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 commentedon Apr 2, 2025
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
grdfill
and the GMT documentation is at ..."?yvonnefroehlich commentedon Apr 3, 2025
Sounds good!
ezevazquez commentedon Apr 30, 2025
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 commentedon Jun 17, 2025
Closed by #3944 and #3965.