Skip to content

Commit 94efac6

Browse files
committed
Clear up handle_option_error docs more
1 parent d1568f3 commit 94efac6

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

libtmux/common.py

+5-5
Original file line numberDiff line numberDiff line change
@@ -636,20 +636,20 @@ def session_check_name(session_name):
636636
def handle_option_error(error):
637637
"""Raises exception if error in option command found.
638638
639-
Purpose: As of tmux 2.4, there are now 3 different types of option errors:
639+
In tmux 3.0, show-option and show-window-otion return invalid option instead of
640+
unknown option. See https://github.com/tmux/tmux/blob/3.0/cmd-show-options.c.
641+
642+
In tmux >2.4, there are 3 different types of option errors:
640643
641644
- unknown option
642645
- invalid option
643646
- ambiguous option
644647
645-
Before 2.4, unknown option was the user.
648+
In tmux <2.4, unknown option was the only option.
646649
647650
All errors raised will have the base error of :exc:`exc.OptionError`. So to
648651
catch any option error, use ``except exc.OptionError``.
649652
650-
In tmux 3.0, show-option and show-window-otion return invalid option instead of
651-
unknown option. See https://github.com/tmux/tmux/blob/3.0/cmd-show-options.c.
652-
653653
Parameters
654654
----------
655655
error : str

0 commit comments

Comments
 (0)