Skip to content

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

@seisman

Description

@seisman
Member

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

Activity

added
discussionsNeed more discussion before taking further actions
on Mar 29, 2025
seisman

seisman commented on Apr 2, 2025

@seisman
MemberAuthor

@GenericMappingTools/pygmt-maintainers 👍 or 👎 ?

yvonnefroehlich

yvonnefroehlich commented on Apr 2, 2025

@yvonnefroehlich
Member

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

yvonnefroehlich

yvonnefroehlich commented on Apr 2, 2025

@yvonnefroehlich
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

seisman commented on Apr 2, 2025

@seisman
MemberAuthor

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

yvonnefroehlich commented on Apr 3, 2025

@yvonnefroehlich
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

ezevazquez commented on Apr 30, 2025

@ezevazquez

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

added
maintenanceBoring but important stuff for the core devs
and removed
discussionsNeed more discussion before taking further actions
on May 24, 2025
added this to the 0.16.0 milestone on May 24, 2025
seisman

seisman commented on Jun 17, 2025

@seisman
MemberAuthor

Closed by #3944 and #3965.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    maintenanceBoring but important stuff for the core devs

    Type

    No type

    Projects

    Status

    Done

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @seisman@ezevazquez@yvonnefroehlich

        Issue actions

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