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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 5 commits into from
Sep 1, 2021
Merged

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

merged 5 commits into from
Sep 1, 2021

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
maxrjones
maxrjones reviewed Aug 22, 2021
View reviewed changes
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.

pygmt/tests/test_surface.py Show resolved Hide resolved
@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
seisman
seisman approved these changes Sep 1, 2021
View reviewed changes
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 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
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! 🎉

@maxrjones maxrjones mentioned this pull request Sep 1, 2021
Merged
5 tasks
weiji14
weiji14 approved these changes Sep 1, 2021
View reviewed changes
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
@obaney @maxrjones @actions-bot
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 <[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
Reviewers

@seisman seisman seisman approved these changes

@maxrjones maxrjones maxrjones approved these changes

@weiji14 weiji14 weiji14 approved these changes

Assignees

@maxrjones maxrjones

@obaney obaney

Labels
deprecation Deprecating a feature eswn-workshop Good 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