Skip to content

Commit 0094f91

Browse files
committed
options(docs): Update g parameter docstrings to reflect DeprecatedError
why: Docstrings still described g as functional when it now raises error what: - Update 6 docstring locations to indicate g raises DeprecatedError - Add deprecation directive pointing to global_ replacement
1 parent 3eb0714 commit 0094f91

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

src/libtmux/options.py

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -797,8 +797,9 @@ def _show_options_raw(
797797
798798
Parameters
799799
----------
800-
g : str, optional
801-
Pass ``-g`` flag for global variable, default False.
800+
g : bool, optional
801+
.. deprecated:: 0.50.0
802+
Use ``global_`` instead. Raises :exc:`~libtmux.exc.DeprecatedError`.
802803
803804
Examples
804805
--------
@@ -864,8 +865,9 @@ def _show_options_dict(
864865
865866
Parameters
866867
----------
867-
g : str, optional
868-
Pass ``-g`` flag for global variable, default False.
868+
g : bool, optional
869+
.. deprecated:: 0.50.0
870+
Use ``global_`` instead. Raises :exc:`~libtmux.exc.DeprecatedError`.
869871
870872
Examples
871873
--------
@@ -913,8 +915,9 @@ def _show_options(
913915
914916
Parameters
915917
----------
916-
g : str, optional
917-
Pass ``-g`` flag for global variable, default False.
918+
g : bool, optional
919+
.. deprecated:: 0.50.0
920+
Use ``global_`` instead. Raises :exc:`~libtmux.exc.DeprecatedError`.
918921
919922
Examples
920923
--------
@@ -1013,7 +1016,8 @@ def _show_option_raw(
10131016
----------
10141017
option : str
10151018
g : bool, optional
1016-
Pass ``-g`` flag, global. Default False.
1019+
.. deprecated:: 0.50.0
1020+
Use ``global_`` instead. Raises :exc:`~libtmux.exc.DeprecatedError`.
10171021
10181022
Raises
10191023
------
@@ -1104,7 +1108,8 @@ def _show_option(
11041108
----------
11051109
option : str
11061110
g : bool, optional
1107-
Pass ``-g`` flag, global. Default False.
1111+
.. deprecated:: 0.50.0
1112+
Use ``global_`` instead. Raises :exc:`~libtmux.exc.DeprecatedError`.
11081113
11091114
Raises
11101115
------
@@ -1206,7 +1211,8 @@ def show_option(
12061211
----------
12071212
option : str
12081213
g : bool, optional
1209-
Pass ``-g`` flag, global. Default False.
1214+
.. deprecated:: 0.50.0
1215+
Use ``global_`` instead. Raises :exc:`~libtmux.exc.DeprecatedError`.
12101216
12111217
Raises
12121218
------

0 commit comments

Comments
 (0)