Skip to content

Commit 19f4c27

Browse files
committed
docs(cli[utils]): Fix parameter docstrings
1 parent ee2b9ad commit 19f4c27

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

src/tmuxp/cli/utils.py

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,10 @@ def prompt(
4040
4141
Parameters
4242
----------
43-
:param name: prompt text
44-
:param default: default value if no input provided.
43+
name :
44+
prompt text
45+
default :
46+
default value if no input provided.
4547
4648
Returns
4749
-------
@@ -83,10 +85,14 @@ def prompt_bool(
8385
8486
Parameters
8587
----------
86-
:param name: prompt text
87-
:param default: default value if no input provided.
88-
:param yes_choices: default 'y', 'yes', '1', 'on', 'true', 't'
89-
:param no_choices: default 'n', 'no', '0', 'off', 'false', 'f'
88+
name :
89+
prompt text
90+
default :
91+
default value if no input provided.
92+
yes_choices :
93+
default 'y', 'yes', '1', 'on', 'true', 't'
94+
no_choices :
95+
default 'n', 'no', '0', 'off', 'false', 'f'
9096
9197
Returns
9298
-------
@@ -130,11 +136,15 @@ def prompt_choices(
130136
131137
Parameters
132138
----------
133-
:param name: prompt text
134-
:param choices: list or tuple of available choices. Choices may be
135-
single strings or (key, value) tuples.
136-
:param default: default value if no input provided.
137-
:param no_choice: acceptable list of strings for "null choice"
139+
name :
140+
prompt text
141+
choices :
142+
list or tuple of available choices. Choices may be single strings or
143+
(key, value) tuples.
144+
default :
145+
default value if no input provided.
146+
no_choice :
147+
acceptable list of strings for "null choice"
138148
139149
Returns
140150
-------
@@ -274,6 +284,6 @@ def unstyle(text: str) -> str:
274284
275285
Credit: click.
276286
277-
:param text: the text to remove style information from.
287+
text : the text to remove style information from.
278288
"""
279289
return strip_ansi(text)

0 commit comments

Comments
 (0)