Skip to content

Commit 36673c0

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 668ec12 commit 36673c0

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
@@ -34,6 +34,24 @@ $ uvx --from 'libtmux' --prerelease allow python
3434

3535
_Future release notes will be placed here_
3636

37+
#### APIs deprecated (#611)
38+
39+
- **Deprecated APIs now raise**: All items below now raise `libtmux.exc.DeprecatedError` (hard error) instead of emitting `DeprecationWarning`. See {doc}`migration` for full context and examples.
40+
41+
| Deprecated API | Replacement | Note |
42+
|----------------|-------------|------|
43+
| `kill_server()` | {meth}`~libtmux.Server.kill` | Server
44+
| `attach_session()`, `kill_session()` | {meth}`~libtmux.Session.attach`, {meth}`~libtmux.Session.kill` | Session
45+
| `select_window()`, `kill_window()`, `split_window()` | {meth}`~libtmux.Window.select`, {meth}`~libtmux.Window.kill`, {meth}`~libtmux.Window.split` | Window
46+
| `resize_pane()`, `select_pane()`, `split_window()` | {meth}`~libtmux.Pane.resize`, {meth}`~libtmux.Pane.select`, {meth}`~libtmux.Pane.split` | Pane
47+
| `attached_window`, `attached_pane` | {attr}`~libtmux.Session.active_window`, {attr}`~libtmux.Session.active_pane` / {attr}`~libtmux.Window.active_pane` | Session/Window
48+
| `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
49+
| Dict-style access (`obj["key"]`, `obj.get(...)`) | Attribute access (e.g., {attr}`~libtmux.window.Window.window_name`) | All tmux objects
50+
| `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
51+
| `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
52+
53+
> Tip: The complete, versioned deprecation matrix lives in `MIGRATION` under "Complete Deprecation Reference".
54+
3755
## libtmux 0.50.0 (2025-11-30)
3856

3957
### Overview

0 commit comments

Comments
 (0)