Skip to content

Commit 90ebcee

Browse files
committed
docs(CHANGES) Document return type annotation fixes
why: Users relying on type hints should know about the corrected return types. what: - Add changelog entry for capture_pane() and display_message() type fixes
1 parent 7fb2981 commit 90ebcee

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

CHANGES

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,8 @@ _Upcoming changes will be written here._
3939
- Normalize docs headings and Sphinx module directives to fix anchor and index generation issues.
4040
- Tweak Sphinx type-hints configuration to avoid RST indentation conflicts and suppress forward-reference warnings.
4141
- Refresh docstrings and cross-references (pane/window APIs, environment helpers, pytest plugin) for clearer return types and stable anchors.
42+
- Fix incorrect return type annotations for `capture_pane()` and `display_message()` methods
43+
(changed from `str | list[str]` to `list[str]` - the methods always return a list).
4244

4345
## libtmux 0.50.0 (2025-11-30)
4446

0 commit comments

Comments
 (0)