Skip to content

Commit 2a3bea2

Browse files
committed
docs(CHANGES): Note env and option lookup changes
1 parent 6203b8b commit 2a3bea2

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

CHANGES

+49
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,55 @@ $ pip install --user --upgrade --pre libtmux
1212

1313
- _Insert changes/features/fixes for next release here_
1414

15+
# Breaking changes
16+
17+
- Deprecated individual item lookups ({issue}`390`)
18+
19+
- Removed key lookups from {meth}`libtmux.common.EnvironmentMixin.show_environment`
20+
21+
Only `EnvironmentMixin.show_environment()` (without an argument) exists, and
22+
it still returns a `dict`.
23+
24+
- Add key lookups via {meth}`libtmux.common.EnvironmentMixin.getenv`
25+
26+
```python
27+
# Before
28+
server.show_environment('DISPLAY')
29+
30+
# After
31+
server.getenv('DISPLAY')
32+
33+
# Before
34+
session.show_environment('DISPLAY')
35+
36+
# After
37+
session.getenv('DISPLAY')
38+
```
39+
40+
- Removed key lookups from {meth}`Session.show_options`
41+
42+
```python
43+
session.show_options() # still returns dict, without an argument
44+
45+
# Old
46+
session.show_options('DISPLAY')
47+
48+
# Now
49+
session.show_option('DISPLAY')
50+
```
51+
52+
- Removed key lookups from {meth}`Window.show_window_options`
53+
54+
```python
55+
window.show_window_options() # still returns dict, without an argument
56+
57+
# Old
58+
window.show_window_options('DISPLAY')
59+
60+
# Now
61+
window.show_window_option('DISPLAY')
62+
```
63+
1564
### Development
1665

1766
- Fix incorrect function name `findWhere()` ({issue}`391`)

0 commit comments

Comments
 (0)