Figure.text: Deprecate parameter "incols" to "use_word" (remove in v0.10.0) #1964
Figure.text: Deprecate parameter "incols" to "use_word" (remove in v0.10.0) #1964willschlitzer merged 19 commits intoGenericMappingTools:mainfrom yvonnefroehlich:update-text-doc-incols
Conversation
I started working on this. At the moment the deprecation cycle includes (only) two minor releases, starting at 0.8.0 and ending at 1.0.0 (not 0.10.0 corresponding to the announcement draft). I am unsure about how to
|
-i placeholder with -it docstring in pygmt.Figure.text() pygmt.Figure.text()
pygmt.Figure.text() incols to use_word in pygmt.Figure.text()
I think changing
Yes. |
Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
incols to use_word in pygmt.Figure.text()
seisman
left a comment
There was a problem hiding this comment.
Do you think we should add a test for it?
willschlitzer
left a comment
There was a problem hiding this comment.
Not necessary for just the deprecation of a parameter, but could a new test be written or an existing test modified to include this new parameter? I think it might be good to make sure that text is consistently reading a string from an input file.
Yes, I agree. This can be done in a separate PR. |
….10.0) (GenericMappingTools#1964) * Rename 'incols' to 'use_word' * Replace -i placeholder with -it docstring * Add 'deprecate_parameter' for two minor releases * Remove 'i' or 'it' from 'kwargs_to_strings' * Adjust docstring corresponding to 'use_word=<integer>' Co-authored-by: Dongdong Tian <seisman.info@gmail.com>
Description of proposed changes
Fixes #1947
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