Skip to content

Rename outfile parameter in surface to be outgrid #1441

Closed
#1458
Closed
Rename outfile parameter in surface to be outgrid#1441
#1458
Labels
deprecationDeprecating a featureeswn-workshopGood issues for first-contributions during the ESWN-PyGMT workshopgood first issueGood for newcomershelp wantedHelping hands are appreciated
Milestone
0.5.0

Description

@weiji14
weiji14
opened on 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.

pygmt/pygmt/src/surface.py

Line 23 in ebbb0cc

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.

Activity

  1. weiji14
    added
    deprecationDeprecating a feature
    on Aug 11, 2021
  2. weiji14
    added this to the 0.5.0 milestone on Aug 11, 2021
  3. seisman
    added
    good first issueGood for newcomers
    on Aug 12, 2021
  4. maxrjones
    added
    eswn-workshopGood issues for first-contributions during the ESWN-PyGMT workshop
    on Aug 17, 2021

  5. maxrjones commented on Aug 18, 2021

    @maxrjones
    maxrjones
    on Aug 18, 2021
    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]

  6. maxrjones
    added
    help wantedHelping hands are appreciated
    on Aug 19, 2021

  7. maxrjones commented on Aug 19, 2021

    @maxrjones
    maxrjones
    on Aug 19, 2021
    Member

    @obaney will be working on this issue!

  8. maxrjones
    closed this as completedin #1458on Sep 1, 2021

  9. seisman commented on Sep 1, 2021

    @seisman
    seisman
    on Sep 1, 2021
    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]

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

  10. weiji14 commented on Sep 1, 2021

    @weiji14
    weiji14
    on Sep 1, 2021
    MemberAuthor

    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    deprecationDeprecating a featureeswn-workshopGood issues for first-contributions during the ESWN-PyGMT workshopgood first issueGood for newcomershelp wantedHelping hands are appreciated

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions