Skip to content

pygmt.surface: Deprecate parameter "outfile" to "outgrid" (remove in v0.7.0) - #1458

Merged
maxrjones merged 5 commits into
GenericMappingTools:mainfrom
obaney:surfacepy-outfile-outgrid
Sep 1, 2021
Merged

pygmt.surface: Deprecate parameter "outfile" to "outgrid" (remove in v0.7.0)#1458
maxrjones merged 5 commits into
GenericMappingTools:mainfrom
obaney:surfacepy-outfile-outgrid

Conversation

@obaney

@obaneyobaney commented Aug 19, 2021

Copy link
Copy Markdown
Contributor

Description of proposed changes

  • Added a deprecate descriptor with remove version 0.7.0, and changed all mention of "outfile" parameter to "outgrid" in surface.py
  • Switched all mentions of "outfile" parameter to "outgrid" in the test_surface.py file

Fixes#1441

Reminders

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst.
  • Write detailed docstrings for all functions/methods.
  • If adding new functionality, add an example to docstrings or tutorials.

Slash Commands

You can write slash commands (/command) in the first line of a comment to perform
specific operations. Supported slash commands are:

  • /format: automatically format and lint the code
  • /test-gmt-dev: run full tests on the latest GMT development version

@weiji14weiji14 added the deprecation Deprecating a feature label Aug 20, 2021
@seismanseisman added this to the 0.5.0 milestone Aug 20, 2021
maxrjones
maxrjones reviewed Aug 22, 2021
View reviewed changes

@maxrjonesmaxrjones left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work! I have made one suggestion for adding a test.

Comment threadpygmt/tests/test_surface.py
@seisman

seisman commented Aug 29, 2021

Copy link
Copy Markdown
Member

Ping @obaney.

@obaneyMeghan Jones
Update pygmt/tests/test_surface.py
aa041f3
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
@obaney

obaney commented Sep 1, 2021

Copy link
Copy Markdown
ContributorAuthor

Merged in @meghanrjones 's helpful test suggestion, it appears that I am failing some checks however

@seisman

seisman commented Sep 1, 2021

Copy link
Copy Markdown
Member

/format

@seismanseisman changed the title Surfacepy outfile outgridpygmt.surface: Deprecate parameter "outfile" to "outgrid" (remove in v0.7.0)Sep 1, 2021
seisman
seisman approved these changes Sep 1, 2021
View reviewed changes

@seismanseisman left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@seismanseisman added the final review call This PR requires final review and approval from a second reviewer label Sep 1, 2021
maxrjones
maxrjones approved these changes Sep 1, 2021
View reviewed changes

@maxrjonesmaxrjones left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great work, thanks @obaney! 🎉

@maxrjonesmaxrjones mentioned this pull request Sep 1, 2021
Merged
5 tasks
weiji14
weiji14 approved these changes Sep 1, 2021
View reviewed changes

@weiji14weiji14 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thanks @obaney!

@meghanrjones, I think we can merge this in directly and then do #1439.

@maxrjones
maxrjones merged commit 4b2bf85 into GenericMappingTools:mainSep 1, 2021
@maxrjonesmaxrjones removed the final review call This PR requires final review and approval from a second reviewer label Sep 1, 2021
@maxrjonesmaxrjones added the eswn-workshop Good issues for first-contributions during the ESWN-PyGMT workshop label Sep 27, 2021
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
@obaneyMeghan Jones
@actions-botJosh Sixsmith
pygmt.surface: Deprecate parameter "outfile" to "outgrid" (remove in …
c816738
…v0.7.0) (GenericMappingTools#1458)
* Rename outfile to outgrid in surface
* Switch outfile to outgrid in test file
* Update pygmt/tests/test_surface.py
Co-authored-by: Meghan Jones <meghanj@alum.mit.edu>
Co-authored-by: actions-bot <58130806+actions-bot@users.noreply.github.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@seismanseismanseisman approved these changes
@maxrjonesmaxrjonesmaxrjones approved these changes
@weiji14weiji14weiji14 approved these changes

Assignees

@maxrjonesmaxrjones

@obaneyobaney

Labels

deprecationDeprecating a featureeswn-workshopGood issues for first-contributions during the ESWN-PyGMT workshop

Projects

None yet

Milestone

0.5.0

Development

Successfully merging this pull request may close these issues.

Rename outfile parameter in surface to be outgrid

5 participants

@obaney@seisman@maxrjones@weiji14@actions-bot