Skip to content

Conversation

@obaney
Copy link
Contributor

@obaney obaney commented Aug 19, 2021

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

@weiji14 weiji14 added the deprecation Deprecating a feature label Aug 20, 2021
@seisman seisman added this to the 0.5.0 milestone Aug 20, 2021
Copy link
Member

@maxrjones maxrjones left a comment

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.

@seisman
Copy link
Member

seisman commented Aug 29, 2021

Ping @obaney.

@obaney
Copy link
Contributor Author

obaney commented Sep 1, 2021

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

@seisman
Copy link
Member

seisman commented Sep 1, 2021

/format

@seisman seisman changed the title Surfacepy outfile outgrid pygmt.surface: Deprecate parameter "outfile" to "outgrid" (remove in v0.7.0) Sep 1, 2021
Copy link
Member

@seisman seisman left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@seisman seisman requested a review from maxrjones September 1, 2021 19:11
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label Sep 1, 2021
Copy link
Member

@maxrjones maxrjones left a comment

Choose a reason for hiding this comment

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

Great work, thanks @obaney! 🎉

Copy link
Member

@weiji14 weiji14 left a comment

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:main Sep 1, 2021
@maxrjones maxrjones removed the final review call This PR requires final review and approval from a second reviewer label Sep 1, 2021
@maxrjones maxrjones 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
…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 <[email protected]>
Co-authored-by: actions-bot <[email protected]>
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rename outfile parameter in surface to be outgrid

5 participants