Skip to content
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

Allow multiple aliases for the same option flag #2751

Closed
seisman opened this issue Oct 17, 2023 · 2 comments
Closed

Allow multiple aliases for the same option flag #2751

seisman opened this issue Oct 17, 2023 · 2 comments
Labels
discussions Need more discussion before taking further actions wontfix This will not be worked on

Comments

@seisman
Copy link
Member

seisman commented Oct 17, 2023

See GenericMappingTools/gmt#7923 for context.

In PyGMT, -j is aliased to distcal, but upstream GMT suggests metric.

We need to discuss if we want to allow multiple aliases or deprecate distcal to metric.

@seisman seisman added the question Further information is requested label Oct 17, 2023
@yvonnefroehlich
Copy link
Member

At the moment, I prefer to have exactly one alias for one option flag. I personally find it confusing to have multiple aliases, as it indicates a difference that actually does not exist. However, the Julia wrapper seems to allow for multiple aliases. Hm... Is there a "Pythonic rule" regarding this issue or decision?

I agree that it is confusing to have different aliases between GMT and PyGMT, and we should try to focus on consistency.

In case we decide on multiple aliases, how is this realized in the examples? Do we want to define a "preferred" or "recommended" alias, which is then used in all examples? Or do we have to update the examples to mention all available aliases? If we used different aliases across the examples for the same thing, I feel that at least new users would definitely get confused.

@seisman seisman added discussions Need more discussion before taking further actions wontfix This will not be worked on and removed question Further information is requested labels Apr 9, 2024
@seisman
Copy link
Member Author

seisman commented Apr 9, 2024

I think multiple aliases cause more trouble than benefits. Closing the issue and feel free to reopen the issue if you don't argee.

@seisman seisman closed this as completed Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discussions Need more discussion before taking further actions wontfix This will not be worked on
Projects
None yet
Development

No branches or pull requests

2 participants