Skip to content

Commit 5f91934

Browse files
committed
docs(CHANGES): Note builder terminal size detection
1 parent 93b368b commit 5f91934

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

CHANGES

+25
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,31 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
1919

2020
<!-- Maintainers, insert changes / features for the next release here -->
2121

22+
### Breaking change
23+
24+
#### Workspace builder now detects terminal size (#926)
25+
26+
Dimensions used by workspace builder now use {py:func}`shutil.get_terminal_size()`.
27+
28+
In conjunction with `main-pane-height: 67%`, for instance, this will render a
29+
proportional layout:
30+
31+
```yaml
32+
session_name: my session
33+
windows:
34+
- window_name: example with percentage
35+
focus: True
36+
layout: main-horizontal
37+
options:
38+
main-pane-height: 67%
39+
panes:
40+
- focus: true
41+
- pane
42+
```
43+
44+
To use old behavior, set `TMUXP_DETECT_TERMINAL_SIZE=0` in your terminal
45+
environment and file an issue on the tracker.
46+
2247
### Documentation
2348

2449
- Automatically linkify links that were previously only text.

0 commit comments

Comments
 (0)