-
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
Rename outfile parameter in surface to be outgrid #1441
Comments
This is somewhat related - I am not sure if it's worth a deprecation but I think we should decide on whether the parameter for tabular input is
It would also be worthwhile to set a consistent order for the positional arguments x, y, [z], data, [outfile] |
@obaney will be working on this issue! |
Perhaps we need to open a separate issue to discuss it. |
Yep, just opened #1479. Let's discuss there. |
Description of the desired feature
As mentioned at #1439 (comment), most PyGMT functions which return a grid output have a parameter called
outgrid
, but thesurface
function usesoutfile
. It would be best to standardize the name to beoutgrid
instead.pygmt/pygmt/src/surface.py
Line 23 in ebbb0cc
Should we deprecate the
outfile
parameter in 2 minor versions (at PyGMT v0.7.0) or 4 minor versions (at PyGMT v0.9.0)? Vote 👀 for 2 and 🎉 for 4.Are you willing to help implement and maintain this feature? Someone can follow our deprecation policy steps at https://www.pygmt.org/v0.4.1/maintenance.html#backwards-compatibility-and-deprecation-policy to resolve this issue.
The text was updated successfully, but these errors were encountered: