Skip to content

Commit

Permalink
docs(CHANGES): Updates for #535
Browse files Browse the repository at this point in the history
  • Loading branch information
tony committed Mar 17, 2024
1 parent 12b4d39 commit f88fd29
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
2 changes: 1 addition & 1 deletion CHANGES
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ $ pip install --user --upgrade --pre libtmux

### Breaking changes

#### Command target change (#919)
#### Command target change (#535)

Commands: All `cmd()` methods using custom or overridden targets must use the keyword argument
`target`. This avoids entanglement with inner shell values that include `-t` for
Expand Down
18 changes: 18 additions & 0 deletions MIGRATION
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,24 @@ _Detailed migration steps for the next version will be posted here._

<!-- To the maintainers and contributors: please add migration details for the upcoming release here -->

## 0.35.0: Commands require explicit targets (2024-03-17)

### Commands require explicit targets (#535)

- {meth}`Server.cmd()`, {meth}`Session.cmd()`, {meth}`Window.cmd()`, {meth}`Pane.cmd()` require passing `target` instead of `['-t', target]`, `['-tTargetName']`, etc. This change is to avoid issues mistakenly interpretting `-t` in other shell values as targets.

Before:

```python
session.cmd('send-keys', 'echo hello', '-t', '0')
```

With 0.35.0 and after:

```python
session.cmd('send-keys', 'echo hello', target='0')
```

## 0.33.0: Deprecations for splitting (2024-03-03)

### Deprecations (#532)
Expand Down

0 comments on commit f88fd29

Please sign in to comment.