-
Notifications
You must be signed in to change notification settings - Fork 224
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
No aliases lists given in docs for some functions or methods #2185
Comments
Ping @weiji14 |
The pygmt/pygmt/src/triangulate.py Lines 151 to 153 in e4e4c43
pygmt/pygmt/src/triangulate.py Lines 277 to 279 in e4e4c43
so the We could discuss whether it's worth spending time to add the alias list, though it would be quite involved I think (also considering the eventual goal is to drop single character aliases, xref #262). What might be a better use of time is to wrap the remainder of the short parameters in https://docs.generic-mapping-tools.org/6.4/triangulate.html (e.g. P.S. The same issue also applies for https://www.pygmt.org/v0.7.0/api/generated/pygmt.grdhisteq.html |
pygmt.triangulate*
I apologize for my delayed response! Thanks @weiji14 for your explanation!
Yes, I realized this, when I added the
I can not comment on how much effort adding the alias list would be. Could this be done in a general way and applied to all functions and methods which currently do not have an alias list in the documentation?
From a long-term perspective and considering the proposed goal to drop the single chracter aliases, I feel, as mention by @weiji14, it makes sense to prioritize wrapping the remainder of the short parameters.
I adjusted the title of the issue and my initial comment above. |
There are no aliases lists given in the documentation for the class pygmt.triangulate and its methods
Is this intended?
Edit (see comment by @weiji14 below): This is simliar for the class pygmt.grdhisteq and its methods pygmt.grdhisteq.compute_bins and pygmt.grdhisteq.equalize_grid.
The text was updated successfully, but these errors were encountered: