File tree Expand file tree Collapse file tree 3 files changed +38
-0
lines changed Expand file tree Collapse file tree 3 files changed +38
-0
lines changed Original file line number Diff line number Diff line change 1+ # Migration notes
2+
3+ Migration and deprecation notes for libtmux are here, see {ref}` changelog ` as
4+ well.
5+
6+ ``` {admonition} Welcome on board! 👋
7+ 1. 📌 For safety, **always** pin the package
8+ 2. 📖 Check the migration notes _(You are here)_
9+ 3. 📣 If you feel something got deprecated too fast, voice your opinion on the [tracker].
10+
11+ We want to make libtmux fun, reliable, and useful for users.
12+
13+ API changes can be painful.
14+
15+ If we can do something to draw the sting, we'll do it. We're taking a balanced approach. That's why these notes are here!
16+
17+ (Please pin the package. 🙏)
18+
19+ [tracker]: https://github.com/tmux-python/libtmux/discussions
20+ ```
21+
22+ ## Next release
23+
24+ _ Add migration notes here_
25+
26+ <!-- -
27+ # vim: set filetype=markdown:
28+ -->
Original file line number Diff line number Diff line change @@ -29,6 +29,7 @@ pytest-plugin/index
2929developing
3030internals/index
3131history
32+ migration
3233glossary
3334GitHub <https://github.com/tmux-python/libtmux>
3435```
Original file line number Diff line number Diff line change 1+ (migration)=
2+
3+ ``` {currentmodule} libtmux
4+
5+ ```
6+
7+ ``` {include} ../MIGRATION
8+
9+ ```
You can’t perform that action at this time.
0 commit comments