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

Figure.text: Deprecate parameter "incols" to "use_word" (remove in v0.10.0) #1964

Merged
merged 19 commits into from
Nov 18, 2022
Merged

Figure.text: Deprecate parameter "incols" to "use_word" (remove in v0.10.0) #1964

Changes from 7 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
4d1d5de
replace -i placeholder with -it docstring
yvonnefroehlich Jun 16, 2022
a701b6d
Rename 'incols' to 'use_word'
yvonnefroehlich Jul 2, 2022
43f9846
Add 'deprecate_parameter for two minor releases
yvonnefroehlich Jul 2, 2022
88887dc
Remove 'i' or 'it' from 'kwargs_to_strings'
yvonnefroehlich Jul 2, 2022
68486a4
Adjust docstring corresponding to 'use_word=<integer>'
yvonnefroehlich Jul 2, 2022
87f6feb
Correct order of imports
yvonnefroehlich Jul 2, 2022
4590609
Change remove_version from 1.0.0 to 0.10.0
yvonnefroehlich Jul 8, 2022
6c91d71
Merge branch 'main' into update-text-doc-incols
yvonnefroehlich Aug 25, 2022
94e2a9c
Merge branch 'main' into update-text-doc-incols
yvonnefroehlich Sep 2, 2022
fd004e5
Merge branch 'main' into update-text-doc-incols
yvonnefroehlich Sep 14, 2022
515565d
Merge branch 'main' into update-text-doc-incols
yvonnefroehlich Sep 20, 2022
30d6df7
Merge branch 'main' into update-text-doc-incols
yvonnefroehlich Sep 24, 2022
b4984c5
Merge branch 'main' into update-text-doc-incols
yvonnefroehlich Sep 25, 2022
75dd33e
Merge branch 'main' into update-text-doc-incols
yvonnefroehlich Oct 4, 2022
c881db3
Merge branch 'main' into update-text-doc-incols
yvonnefroehlich Nov 9, 2022
551e5bc
Merge branch 'main' into update-text-doc-incols
yvonnefroehlich Nov 11, 2022
8ad152e
Aliasing '-it' to 'use_word' (code review)
yvonnefroehlich Nov 12, 2022
b5f1829
Merge branch 'main' into update-text-doc-incols
yvonnefroehlich Nov 15, 2022
0e5838d
Merge branch 'main' into update-text-doc-incols
yvonnefroehlich Nov 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 7 additions & 3 deletions pygmt/src/text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
from pygmt.helpers import (
build_arg_string,
data_kind,
deprecate_parameter,
fmt_docstring,
is_nonstr_iter,
kwargs_to_strings,
Expand All @@ -15,6 +16,7 @@


@fmt_docstring
@deprecate_parameter("incols", "use_word", "v0.8.0", remove_version="v0.10.0")
@use_alias(
R="region",
J="projection",
Expand All @@ -33,7 +35,7 @@
e="find",
f="coltypes",
h="header",
i="incols",
i="use_word",
yvonnefroehlich marked this conversation as resolved.
Show resolved Hide resolved
p="perspective",
t="transparency",
w="wrap",
Expand All @@ -45,7 +47,6 @@
font="sequence_comma",
justify="sequence_comma",
c="sequence_comma",
i="sequence_comma",
p="sequence",
)
def text_(
Expand Down Expand Up @@ -156,7 +157,10 @@ def text_(
{e}
{f}
{h}
{i}
use_word : int
Select a specific word from the trailing text, with the first
word being 0 [Default is the entire trailing text]. No numerical
columns can be specified.
{p}
{t}
*transparency* can also be a 1d array to set varying transparency
Expand Down