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.

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

Figure.plot3d: Deprecate parameter "sizes" to "size" (remove in v0.6.0) #1258

Merged
merged 8 commits into from
May 7, 2021

Conversation

seisman
Copy link
Member

@seisman seisman commented May 4, 2021

Description of proposed changes

Closes #1118.

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

@seisman seisman added this to the 0.4.0 milestone May 4, 2021
@seisman seisman added the deprecation Deprecating a feature label May 4, 2021
pygmt/src/plot3d.py Outdated Show resolved Hide resolved
Copy link
Member

@core-man core-man 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~

Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
@seisman seisman changed the title Figure.plot3d: Deprecate parameter "sizes" to "size" (will be removed in v0.6.0) Figure.plot3d: Deprecate parameter "sizes" to "size" (removed in v0.6.0) May 6, 2021
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.

Just a similar suggestion to my comment on #1254 (comment) to use pytest.warns (see also https://docs.pytest.org/en/6.2.x/warnings.html#warns).

pygmt/tests/test_plot3d.py Outdated Show resolved Hide resolved
pygmt/tests/test_plot3d.py Outdated Show resolved Hide resolved
pygmt/tests/test_plot3d.py Outdated Show resolved Hide resolved
@seisman seisman changed the title Figure.plot3d: Deprecate parameter "sizes" to "size" (removed in v0.6.0) Figure.plot3d: Deprecate parameter "sizes" to "size" (remove in v0.6.0) May 6, 2021
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
@seisman seisman merged commit 4777a6f into master May 7, 2021
@seisman seisman deleted the plot3d-sizes branch May 7, 2021 04:06
weiji14 added a commit that referenced this pull request Mar 13, 2022
Remove the parameter "sizes" in favour of "size" from `Figure.plot`
and `Figure.plot3d`. Deprecation warning was added in v0.4.0
(xref #1254, #1258), and is to be fully removed in v0.6.0.
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…0) (GenericMappingTools#1258)

* Rename 'sizes' to 'size'
* Updates tests and examples to use the new parameter name
* Use the deprecate_parameter decorator for backward-compatibility
* Add a test for checking 'sizes' backward compatibility

Co-authored-by: Michael Grund <23025878+michaelgrund@users.noreply.github.com>
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…ericMappingTools#1809)

Remove the parameter "sizes" in favour of "size" from `Figure.plot`
and `Figure.plot3d`. Deprecation warning was added in v0.4.0
(xref GenericMappingTools#1254, GenericMappingTools#1258), and is to be fully removed in v0.6.0.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation Deprecating a feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename the sizes parameter in plot/plot3d to be size
4 participants