Figure.plot: Deprecate parameter "sizes" to "size" (remove in v0.6.0)#1254
Figure.plot: Deprecate parameter "sizes" to "size" (remove in v0.6.0)#1254
Conversation
core-man
left a comment
There was a problem hiding this comment.
All are good except one minor comment.
michaelgrund
left a comment
There was a problem hiding this comment.
Except the comment provided by @core-man, everything looks fine to me!
|
Since the PR title will be used in the release notes, I just changed the PR title to
to make it more readable. I expect to have a "consistent" PR title for parameter deprecations like this, so suggestions on the PR title format are also welcomed. |
weiji14
left a comment
There was a problem hiding this comment.
Since the PR title will be used in the release notes, I just changed the PR title to
Figure.plot: Deprecate parameter "sizes" to "size" (will be removed in v0.6.0)
to make it more readable.
I expect to have a "consistent" PR title for parameter deprecations like this, so suggestions on the PR title format are also welcomed.
Looks good. I would just change the 'removed' to 'remove' in the title, i.e. 'Figure.plot: Deprecate parameter "sizes" to "size" (remove in v0.6.0)'
Co-authored-by: Wei Ji <23487320+weiji14@users.noreply.github.com>
…GenericMappingTools#1254) * Rename sizes to size in Figure.plot() * 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: Wei Ji <23487320+weiji14@users.noreply.github.com>
…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.
Description of proposed changes
sizestosizein Figure.plot()Address #1118.
Reminders
make formatandmake checkto make sure the code follows the style guide.doc/api/index.rst.Slash Commands
You can write slash commands (
/command) in the first line of a comment to performspecific operations. Supported slash commands are:
/format: automatically format and lint the code/test-gmt-dev: run full tests on the latest GMT development version