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

Rename outfile parameter in surface to be outgrid #1441

Closed
weiji14 opened this issue Aug 11, 2021 · 4 comments · Fixed by #1458
Closed

Rename outfile parameter in surface to be outgrid #1441

weiji14 opened this issue Aug 11, 2021 · 4 comments · Fixed by #1458
Labels
deprecation Deprecating a feature eswn-workshop Good issues for first-contributions during the ESWN-PyGMT workshop good first issue Good for newcomers help wanted Helping hands are appreciated
Milestone

Comments

@weiji14
Copy link
Member

weiji14 commented Aug 11, 2021

Description of the desired feature

As mentioned at #1439 (comment), most PyGMT functions which return a grid output have a parameter called outgrid, but the surface function uses outfile. It would be best to standardize the name to be outgrid instead.

G="outfile",

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.

@weiji14 weiji14 added the deprecation Deprecating a feature label Aug 11, 2021
@weiji14 weiji14 added this to the 0.5.0 milestone Aug 11, 2021
@seisman seisman added the good first issue Good for newcomers label Aug 12, 2021
@maxrjones maxrjones added the eswn-workshop Good issues for first-contributions during the ESWN-PyGMT workshop label Aug 17, 2021
@maxrjones
Copy link
Member

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 data or table for all modules moving forward. Currently, this is the distribution:

data parameter: surface, wiggle, velo, rose, plot3d, plot, contour
table parameter: blockmedian, blockmean, histogram
other: grdtrack (points), text (textfiles)

It would also be worthwhile to set a consistent order for the positional arguments x, y, [z], data, [outfile]

@maxrjones maxrjones added the help wanted Helping hands are appreciated label Aug 19, 2021
@maxrjones
Copy link
Member

@obaney will be working on this issue!

@seisman
Copy link
Member

seisman commented Sep 1, 2021

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 data or table for all modules moving forward. Currently, this is the distribution:

data parameter: surface, wiggle, velo, rose, plot3d, plot, contour
table parameter: blockmedian, blockmean, histogram
other: grdtrack (points), text (textfiles)

It would also be worthwhile to set a consistent order for the positional arguments x, y, [z], data, [outfile]

Perhaps we need to open a separate issue to discuss it.

@weiji14
Copy link
Member Author

weiji14 commented Sep 1, 2021

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 data or table for all modules moving forward. Currently, this is the distribution:
data parameter: surface, wiggle, velo, rose, plot3d, plot, contour
table parameter: blockmedian, blockmean, histogram
other: grdtrack (points), text (textfiles)
It would also be worthwhile to set a consistent order for the positional arguments x, y, [z], data, [outfile]

Perhaps we need to open a separate issue to discuss it.

Yep, just opened #1479. Let's discuss there.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation Deprecating a feature eswn-workshop Good issues for first-contributions during the ESWN-PyGMT workshop good first issue Good for newcomers help wanted Helping hands are appreciated
Projects
No open projects
Release v0.5.x
  
Awaiting triage
Development

Successfully merging a pull request may close this issue.

3 participants