Skip to content

Commit 401027d

Browse files
committed
CHANGES(docs[breaking]): consolidate #611 deprecation note
why: collapse multiple CHANGES edits into a single entry with correct Sphinx links. what: - keep future release placeholder visible - provide api-linked table for deprecated items now raising DeprecatedError - reference migration doc for details
1 parent 60cef0a commit 401027d

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

CHANGES

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,24 @@ _Upcoming changes will be written here._
4444
- Fix incorrect return type annotations for `capture_pane()` and `display_message()` methods
4545
(changed from `str | list[str]` to `list[str]` - the methods always return a list).
4646

47+
#### APIs deprecated (#611)
48+
49+
Legacy API methods now raise `libtmux.exc.DeprecatedError` (hard error) instead of emitting `DeprecationWarning`.
50+
51+
See {doc}`migration` for full context and examples.
52+
53+
| Deprecated API | Replacement | Note |
54+
|----------------|-------------|------|
55+
| `kill_server()` | {meth}`~libtmux.Server.kill` | Server
56+
| `attach_session()`, `kill_session()` | {meth}`~libtmux.Session.attach`, {meth}`~libtmux.Session.kill` | Session
57+
| `select_window()`, `kill_window()`, `split_window()` | {meth}`~libtmux.Window.select`, {meth}`~libtmux.Window.kill`, {meth}`~libtmux.Window.split` | Window
58+
| `resize_pane()`, `select_pane()`, `split_window()` | {meth}`~libtmux.Pane.resize`, {meth}`~libtmux.Pane.select`, {meth}`~libtmux.Pane.split` | Pane
59+
| `attached_window`, `attached_pane` | {attr}`~libtmux.Session.active_window`, {attr}`~libtmux.Session.active_pane` / {attr}`~libtmux.Window.active_pane` | Session/Window
60+
| `list_*()`, `_list_*()`, `_update_*()`, `children`, `where()`, `find_where()`, `get_by_id()` | {attr}`~libtmux.Server.sessions` / {attr}`~libtmux.Session.windows` / {attr}`~libtmux.Window.panes` with {meth}`~libtmux.common.QueryList.filter` / {meth}`~libtmux.common.QueryList.get` | Query/filter helpers
61+
| Dict-style access (`obj["key"]`, `obj.get(...)`) | Attribute access (e.g., {attr}`~libtmux.window.Window.window_name`) | All tmux objects
62+
| `set_window_option()`, `show_window_option()`, `show_window_options()` | {meth}`~libtmux.window.Window.set_option`, {meth}`~libtmux.window.Window.show_option`, {meth}`~libtmux.window.Window.show_options` | Window
63+
| `g` parameter on options/hooks methods | `global_` on {meth}`~libtmux.options.OptionsMixin.set_option`, {meth}`~libtmux.options.OptionsMixin.show_option`, {meth}`~libtmux.options.OptionsMixin.show_options` | Options & hooks
64+
4765
## libtmux 0.50.0 (2025-11-30)
4866

4967
### Overview

0 commit comments

Comments
 (0)