Skip to content

Rename outfile parameter in surface to be outgrid #1441

@weiji14

Description

@weiji14

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.

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