Skip to content

Commit c0c9fdc

Browse files
committed
docs(CHANGES,MIGRATION): Update for argparse change
1 parent 80b45d2 commit c0c9fdc

File tree

2 files changed

+34
-2
lines changed

2 files changed

+34
-2
lines changed

CHANGES

+20-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,26 @@ $ pipx install --suffix=@next 'tmuxp' --pip-args '\--pre' --force
1717

1818
## tmuxp 1.17.x (unreleased)
1919

20-
- _Insert changes/features/fixes for next release here_
20+
- Notes on upcoming releases will be added here
21+
22+
<!-- Maintainers, insert changes / features for the next release here -->
23+
24+
### Breaking changes
25+
26+
- **Completions have changed** (#830)
27+
28+
Completions now use a different tool: [shtab]. See the [completions page] for more information.
29+
30+
If you were using earlier versions of tmuxp (earlier than 1.17.0), you may need to uninstall the old completions, first.
31+
32+
[completions page]: https://tmuxp.git-pull.com/cli/completion.html
33+
[shtab]: https://docs.iterative.ai/shtab/
34+
35+
- Deprecate `click` in favor of {mod}`argparse` (#830)
36+
37+
### Packages
38+
39+
- Remove `click` dependency
2140

2241
## tmuxp 1.16.2 (2022-10-08)
2342

MIGRATION

+14-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,20 @@ well.
2121

2222
## Next release
2323

24-
_Add migration notes here_
24+
_Notes on the upcoming release will be added here_
25+
26+
<!-- Maintainers, insert changes / features for the next release here -->
27+
28+
## 1.17.x (unreleased)
29+
30+
**Completions have changed** (#830)
31+
32+
Completions now use a different tool: [shtab]. See the [completions page] for more information.
33+
34+
If you were using earlier versions of tmuxp (earlier than 1.17.0), you may need to uninstall the old completions, first.
35+
36+
[completions page]: https://tmuxp.git-pull.com/cli/completion.html
37+
[shtab]: https://docs.iterative.ai/shtab/
2538

2639
<!---
2740
# vim: set filetype=markdown:

0 commit comments

Comments
 (0)