Skip to content

Commit 1d47867

Browse files
committed
docs(CHANGES): Add notes for Session.attach() fix (#616)
why: Document the bug fix and behavioral change for the upcoming release. what: - Add bug fix entry for #616 (attach no longer fails if session killed) - Add breaking change note that attach() no longer calls refresh()
1 parent a1ff647 commit 1d47867

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

CHANGES

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,27 @@ $ uvx --from 'libtmux' --prerelease allow python
3232

3333
<!-- To maintainers and contributors: Please add notes for the forthcoming version below -->
3434

35+
### Breaking changes
36+
37+
#### Session.attach() no longer calls refresh() (#616)
38+
39+
{meth}`~libtmux.Session.attach` previously called {meth}`~libtmux.neo.Obj.refresh`
40+
after the `attach-session` command returned. This was semantically incorrect since
41+
`attach-session` is a blocking interactive command where session state can change
42+
arbitrarily during attachment.
43+
44+
This was never strictly defined behavior as libtmux abstracts tmux internals away.
45+
Code that relied on the session object being refreshed after `attach()` should
46+
explicitly call `session.refresh()` if needed.
47+
48+
### Bug fixes
49+
50+
#### Session.attach() no longer fails if session killed during attachment (#616)
51+
52+
Fixed an issue where {meth}`~libtmux.Session.attach` would raise
53+
{exc}`~libtmux.exc.TmuxObjectDoesNotExist` when a user killed the session while
54+
attached (e.g., closing all windows) and then detached.
55+
3556
## libtmux 0.52.1 (2025-12-07)
3657

3758
### CI

0 commit comments

Comments
 (0)