Skip to content

Figure.rose: Deprecate parameter "columns" to "incols" (remove in v0.6.0) #1306

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

Merged
merged 7 commits into from
May 28, 2021

Conversation

michaelgrund
Copy link
Member

@michaelgrund michaelgrund commented May 27, 2021

Description of proposed changes

This PR adds the deprecate_parameter decorator for backward-compatibility to Figure.rose().

  • Updates tests and examples to use the new parameter name
  • Use the deprecate_parameter decorator for backward-compatibility
  • Add a test for checking 'columns' backward compatibility

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.
  • Write detailed docstrings for all functions/methods.

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

@michaelgrund michaelgrund added the deprecation Deprecating a feature label May 27, 2021
@michaelgrund michaelgrund added this to the 0.4.0 milestone May 27, 2021
@michaelgrund michaelgrund self-assigned this May 27, 2021
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
@seisman seisman added the final review call This PR requires final review and approval from a second reviewer label May 27, 2021
@seisman seisman removed the final review call This PR requires final review and approval from a second reviewer label May 28, 2021
@seisman
Copy link
Member

seisman commented May 28, 2021

For unknown reasons, the test_rose_data_file test fails and the test_rose_no_sectors hangs (likely waiting for input file).

../pygmt/tests/test_rose.py::test_rose_data_file FAILED                                                                         [ 84%]
../pygmt/tests/test_rose.py::test_rose_2d_array_single PASSED                                                                   [ 84%]
../pygmt/tests/test_rose.py::test_rose_2d_array_multiple PASSED                                                                 [ 84%]
../pygmt/tests/test_rose.py::test_rose_plot_data_using_cpt PASSED                                                               [ 85%]
../pygmt/tests/test_rose.py::test_rose_plot_with_transparency FAILED                                                            [ 85%]
../pygmt/tests/test_rose.py::test_rose_no_sectors

@seisman seisman merged commit e6ba08c into master May 28, 2021
@seisman seisman deleted the rose-depr-columns branch May 28, 2021 18:02
sixy6e pushed a commit to sixy6e/pygmt that referenced this pull request Dec 21, 2022
…6.0) (GenericMappingTools#1306)

* Figure.rose: Deprecate parameter "columns" to "incols" (remove in v0.6.0)
* add test for deprecation warning

Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
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.

2 participants