From edb4621dbafac702c4c039bba203fa18b0b370fe Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:14:28 -0600 Subject: [PATCH 01/35] docs: Fix grammatical error in about.md ('ran' to 'run') --- docs/about.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about.md b/docs/about.md index 0f5557c81..7a8167531 100644 --- a/docs/about.md +++ b/docs/about.md @@ -32,7 +32,7 @@ relations of {class}`Server`, {class}`Session`, {class}`Window` and | {class}`Window` | {class}`Pane` | {class}`Session` | | {class}`Pane` | None | {class}`Window` | -Internally, tmux allows multiple servers to be ran on a system. Each one +Internally, tmux allows multiple servers to be run on a system. Each one uses a socket. The server-client architecture is executed so cleanly, many users don't think about it. tmux automatically connects to a default socket name and location for you if none (`-L`, `-S`) is specified. From 84080491dca3b4d1f01816922cc96c77135c112f Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:14:43 -0600 Subject: [PATCH 02/35] docs: Fix repeated word 'and' in developing.md --- docs/developing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developing.md b/docs/developing.md index 149f5df19..747e3d53c 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -1,6 +1,6 @@ # Development -Install and [git] and [uv] +Install [git] and [uv] Clone: From 9229a67851f5abb06092d915d695a578ce664306 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:14:59 -0600 Subject: [PATCH 03/35] docs: Remove redundant 'doctest.' in pytest-plugin/index.md --- docs/pytest-plugin/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pytest-plugin/index.md b/docs/pytest-plugin/index.md index 7c3eed133..9ab359bd5 100644 --- a/docs/pytest-plugin/index.md +++ b/docs/pytest-plugin/index.md @@ -67,7 +67,7 @@ options: - Pass a `config_file` into {class}`~libtmux.Server` - Set the `HOME` directory to a local or temporary pytest path with a configuration file -You could also read the code and override {func}`server fixtures `'s in your own doctest. doctest. +You could also read the code and override {func}`server fixtures `'s in your own doctest. (custom_session_params)= From 8288c78e0a4b728afbd01fe2bfd3b4461bf8cb9f Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:16:29 -0600 Subject: [PATCH 04/35] docs: Fix grammatical error in pytest-plugin/index.md ('These are fixtures are' -> 'These fixtures are') --- docs/pytest-plugin/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pytest-plugin/index.md b/docs/pytest-plugin/index.md index 9ab359bd5..81d3f21e8 100644 --- a/docs/pytest-plugin/index.md +++ b/docs/pytest-plugin/index.md @@ -48,7 +48,7 @@ passed into your test. ## Recommended fixtures -These are fixtures are automatically used when the plugin is enabled and `pytest` is run. +These fixtures are automatically used when the plugin is enabled and `pytest` is run. - Creating temporary, test directories for: - `/home/` ({func}`home_path`) From 4f0d1de145b4f64a2475f56a554ae66e3d8bcd00 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:16:43 -0600 Subject: [PATCH 05/35] docs: Complete session identifier example in about.md --- docs/about.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about.md b/docs/about.md index 7a8167531..250ee313e 100644 --- a/docs/about.md +++ b/docs/about.md @@ -72,7 +72,7 @@ How is libtmux able to keep references to panes, windows and sessions? > > windows use `@`, such as `@2345` > -> sessions use `$`, for money, such as `$` +> sessions use `$`, for money, such as `$13` > > How is libtmux able to handle windows with no names? From 007753737d299db82aeb444c6d8525b3bdbc3b4c Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:16:59 -0600 Subject: [PATCH 06/35] docs: Improve punctuation in make commands documentation --- docs/developing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developing.md b/docs/developing.md index 747e3d53c..28cec3262 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -44,7 +44,7 @@ Default preview server: http://localhost:8023 [sphinx-autobuild] will automatically build the docs, watch for file changes and launch a server. -From home directory: `make start_docs` From inside `docs/`: `make start` +From home directory: `make start_docs`. From inside `docs/`: `make start`. [sphinx-autobuild]: https://github.com/executablebooks/sphinx-autobuild From 5115c5579d226b076500ff6204feefe141659946 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:17:53 -0600 Subject: [PATCH 07/35] docs: Improve clarity of test stability description in pytest-plugin/index.md --- docs/pytest-plugin/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pytest-plugin/index.md b/docs/pytest-plugin/index.md index 81d3f21e8..5127fc23d 100644 --- a/docs/pytest-plugin/index.md +++ b/docs/pytest-plugin/index.md @@ -33,7 +33,7 @@ The pytest plugin will be automatically detected via pytest, and the fixtures wi View libtmux's own [tests/](https://github.com/tmux-python/libtmux/tree/master/tests) as well as tmuxp's [tests/](https://github.com/tmux-python/tmuxp/tree/master/tests). -libtmux's tests `autouse` the {ref}`recommended-fixtures` above to ensure stable, assertions and +libtmux's tests `autouse` the {ref}`recommended-fixtures` above to ensure stable test execution, assertions and object lookups in the test grid. ## pytest-tmux From 3acedf53e97606f2b2b46da6157234c4c1fe008f Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:18:10 -0600 Subject: [PATCH 08/35] docs: Fix incorrect verb usage ('custom' -> 'customize') in pytest-plugin/index.md --- docs/pytest-plugin/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pytest-plugin/index.md b/docs/pytest-plugin/index.md index 5127fc23d..fcd48c6a5 100644 --- a/docs/pytest-plugin/index.md +++ b/docs/pytest-plugin/index.md @@ -73,7 +73,7 @@ You could also read the code and override {func}`server fixtures Date: Mon, 17 Feb 2025 08:18:23 -0600 Subject: [PATCH 09/35] docs: Fix incorrect apostrophe usage in plural 'IDs' --- docs/about.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about.md b/docs/about.md index 250ee313e..1caad8974 100644 --- a/docs/about.md +++ b/docs/about.md @@ -66,7 +66,7 @@ libtmux uses `FORMATTERS` in tmux to give identity attributes to How is libtmux able to keep references to panes, windows and sessions? -> Tmux has unique ID's for sessions, windows and panes. +> Tmux has unique IDs for sessions, windows and panes. > > panes use `%`, such as `%1234` > From 724920cd8caf8542b7c18fb1ccab6878408f8090 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:18:58 -0600 Subject: [PATCH 10/35] docs: Fix incorrect apostrophe usage in plural 'APIs' --- docs/about.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about.md b/docs/about.md index 1caad8974..50eee78ea 100644 --- a/docs/about.md +++ b/docs/about.md @@ -56,7 +56,7 @@ up the data stored in the {class}`Server` object. ## Similarities to tmux and Pythonics libtmux was built in the spirit of understanding how tmux operates -and how python objects and tools can abstract the API's in a pleasant way. +and how python objects and tools can abstract the APIs in a pleasant way. libtmux uses `FORMATTERS` in tmux to give identity attributes to {class}`Session`, {class}`Window` and {class}`Pane` objects. See From d85bb29456215e8b825a5a6a7a51227b04ee65e6 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:19:14 -0600 Subject: [PATCH 11/35] docs: Fix inconsistent pluralization in list of tmux objects --- docs/about.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about.md b/docs/about.md index 50eee78ea..3e1e6adf5 100644 --- a/docs/about.md +++ b/docs/about.md @@ -17,7 +17,7 @@ libtmux is a [typed](https://docs.python.org/3/library/typing.html) [abstraction layer] for tmux. It builds upon the concept of targets `-t`, to direct commands against -individual session, windows and panes and `FORMATS`, template variables +individual sessions, windows and panes and `FORMATS`, template variables exposed by tmux to describe their properties. Think of `-t` analogously to [scope]. From 89d8cbe8f2e349c9543cfab5c3aed97d547f161d Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:19:39 -0600 Subject: [PATCH 12/35] docs: Make entr(1) references consistent in formatting --- docs/developing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/developing.md b/docs/developing.md index 28cec3262..e5ce189fe 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -95,7 +95,7 @@ $ make ruff $ make watch_ruff ``` -requires [`entr(1)`]. +requires [entr(1)]. ```` @@ -177,7 +177,7 @@ $ make mypy $ make watch_mypy ``` -requires [`entr(1)`]. +requires [entr(1)]. ```` ## Releasing From b994132d601cd13ef5bc052b29e9eb3e56b71ffb Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:20:36 -0600 Subject: [PATCH 13/35] docs: Fix inconsistent capitalization of tmux object names --- docs/about.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about.md b/docs/about.md index 3e1e6adf5..62ba1c6de 100644 --- a/docs/about.md +++ b/docs/about.md @@ -41,7 +41,7 @@ A server will be created automatically upon starting if none exists. A server can have multiple sessions. `Ctrl-a s` can be used to switch between sessions running on the server. -Sessions, Windows and Panes all have their own unique identifier for +Sessions, windows and panes all have their own unique identifier for internal purposes. {class}`common.TmuxMappingObject` will make use of the unique identifiers (`session_id`, `window_id`, `pane_id` ) to look up the data stored in the {class}`Server` object. From 347b94462388a932af7fec10b27d47cb357348b1 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:20:51 -0600 Subject: [PATCH 14/35] docs: Remove extra space before parenthesis --- docs/about.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about.md b/docs/about.md index 62ba1c6de..320e78212 100644 --- a/docs/about.md +++ b/docs/about.md @@ -43,7 +43,7 @@ between sessions running on the server. Sessions, windows and panes all have their own unique identifier for internal purposes. {class}`common.TmuxMappingObject` will make use of the -unique identifiers (`session_id`, `window_id`, `pane_id` ) to look +unique identifiers (`session_id`, `window_id`, `pane_id`) to look up the data stored in the {class}`Server` object. | Object | Prefix | Example | From e6e08b58d9f37ae8f22688baaba66f78ba03faee Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:21:17 -0600 Subject: [PATCH 15/35] docs: Make command formatting consistent in developing.md --- docs/developing.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/developing.md b/docs/developing.md index e5ce189fe..fe527c3f5 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -25,7 +25,9 @@ Makefile commands prefixed with `watch_` will watch files and rerun. ## Tests -`uv run py.test` +```console +$ uv run py.test +``` Helpers: `make test` Rerun tests on file change: `make watch_test` (requires [entr(1)]) From 19b66b685a48a9727631f95b7fafd0dcae65a3d6 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:22:32 -0600 Subject: [PATCH 16/35] docs: Remove unnecessary explanation of $ symbol --- docs/about.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about.md b/docs/about.md index 320e78212..e53c97b7e 100644 --- a/docs/about.md +++ b/docs/about.md @@ -72,7 +72,7 @@ How is libtmux able to keep references to panes, windows and sessions? > > windows use `@`, such as `@2345` > -> sessions use `$`, for money, such as `$13` +> sessions use `$`, such as `$13` > > How is libtmux able to handle windows with no names? From f920c7dd911bf3e971c840903b181c75cd01a275 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:22:55 -0600 Subject: [PATCH 17/35] docs: Make helper command formatting consistent --- docs/developing.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/developing.md b/docs/developing.md index fe527c3f5..53e372d9e 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -29,7 +29,12 @@ Makefile commands prefixed with `watch_` will watch files and rerun. $ uv run py.test ``` -Helpers: `make test` +### Helpers + +```console +$ make test +``` + Rerun tests on file change: `make watch_test` (requires [entr(1)]) ### Pytest plugin From 9927873d9083f90c9fa3e4408ae424d99e61af93 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:23:12 -0600 Subject: [PATCH 18/35] docs: Make watch_test command formatting consistent --- docs/developing.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/developing.md b/docs/developing.md index 53e372d9e..ffe4d8260 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -35,7 +35,13 @@ $ uv run py.test $ make test ``` -Rerun tests on file change: `make watch_test` (requires [entr(1)]) +Rerun tests on file change: + +```console +$ make watch_test +``` + +(requires [entr(1)]) ### Pytest plugin From a44258889dd6768ce8db401835265a0b9c3ac12a Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:25:28 -0600 Subject: [PATCH 19/35] docs: Make documentation build commands formatting consistent --- docs/developing.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/developing.md b/docs/developing.md index ffe4d8260..9df8395ac 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -63,7 +63,18 @@ From home directory: `make start_docs`. From inside `docs/`: `make start`. ### Manual documentation (the hard way) -`cd docs/` and `make html` to build. `make serve` to start http server. +```console +$ cd docs/ +$ make html +``` + +to build. + +```console +$ make serve +``` + +to start http server. Helpers: `make build_docs`, `make serve_docs` From 80d37900ccc35f2d27396344ef25a7e8826e17b0 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:27:20 -0600 Subject: [PATCH 20/35] docs: Standardize key combination format (Ctrl-a -> Ctrl+a) --- docs/about.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about.md b/docs/about.md index e53c97b7e..e78047eb3 100644 --- a/docs/about.md +++ b/docs/about.md @@ -38,7 +38,7 @@ many users don't think about it. tmux automatically connects to a default socket name and location for you if none (`-L`, `-S`) is specified. A server will be created automatically upon starting if none exists. -A server can have multiple sessions. `Ctrl-a s` can be used to switch +A server can have multiple sessions. `Ctrl+a s` can be used to switch between sessions running on the server. Sessions, windows and panes all have their own unique identifier for From 108895aa561f45eb974f5755ee7c1627ca4888f7 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:27:36 -0600 Subject: [PATCH 21/35] docs: Replace # symbol with 'number' for clarity --- docs/about.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about.md b/docs/about.md index e78047eb3..3a5c91bba 100644 --- a/docs/about.md +++ b/docs/about.md @@ -82,7 +82,7 @@ How is libtmux able to keep references to panes, windows and sessions? > Pane index refers to the order of a pane on the screen. > -> Window index refers to the # of the window in the session. +> Window index refers to the number of the window in the session. > > To assert pane, window and session data, libtmux will use > {meth}`Server.sessions()`, {meth}`Session.windows()`, From 6e553748706122f6b5ffe73caad5a9eb415528fa Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:29:13 -0600 Subject: [PATCH 22/35] docs: Make start_docs and start commands formatting consistent --- docs/developing.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docs/developing.md b/docs/developing.md index 9df8395ac..5c251ca21 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -57,7 +57,15 @@ Default preview server: http://localhost:8023 [sphinx-autobuild] will automatically build the docs, watch for file changes and launch a server. -From home directory: `make start_docs`. From inside `docs/`: `make start`. +From home directory: +```console +$ make start_docs +``` + +From inside `docs/`: +```console +$ make start +``` [sphinx-autobuild]: https://github.com/executablebooks/sphinx-autobuild From 78eab593be52cd076d297bb7b11932ed70bba693 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:29:48 -0600 Subject: [PATCH 23/35] docs: Make version number formatting consistent (0.10 -> v0.10) --- docs/developing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developing.md b/docs/developing.md index 5c251ca21..f10ea4bc5 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -257,7 +257,7 @@ to PyPI. This isn't used yet since package maintainers may want setup.py in the source. See https://github.com/tmux-python/tmuxp/issues/625. -As of 0.10, [uv] handles virtualenv creation, package requirements, versioning, +As of v0.10, [uv] handles virtualenv creation, package requirements, versioning, building, and publishing. Therefore there is no setup.py or requirements files. Update `__version__` in `__about__.py` and `pyproject.toml`:: From faf9b181f6bc546a86e6fd02a7ad5f2c63148a20 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:34:41 -0600 Subject: [PATCH 24/35] docs: Remove extra blank lines in tmux session creation command block --- docs/quickstart.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 1c17fa87c..62a493425 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -56,9 +56,7 @@ via trunk (can break easily): Now, let's open a tmux session. ```console - $ tmux new-session -n bar -s foo - ``` This tutorial will be using the session and window name in the example. From 12123a50e8a4fde92ec882a9aa213924f949b0bd Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:35:07 -0600 Subject: [PATCH 25/35] docs: Fix grammar in sessions/windows lookup description --- docs/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 62a493425..a2a2439d1 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -175,7 +175,7 @@ Session($1 ...) However, this isn't guaranteed, libtmux works against current tmux information, the session's name could be changed, or another tmux session may be created, -so {meth}`Server.sessions` and {meth}`Server.windows` exists as a lookup. +so {meth}`Server.sessions` and {meth}`Server.windows` exist as a lookup. ## Get session by ID From ecaf2a95491a2e0f80560fe7c491ac2a1b6a19b8 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:35:25 -0600 Subject: [PATCH 26/35] docs: Add missing ptpython link definition --- docs/quickstart.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/quickstart.md b/docs/quickstart.md index a2a2439d1..bb94c5c70 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -50,6 +50,7 @@ via trunk (can break easily): ``` [pip]: https://pip.pypa.io/en/stable/ +[ptpython]: https://github.com/prompt-toolkit/ptpython ## Start a tmux session From c9b5c5274712d9485cddfff665bceb7efc137dd7 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:37:19 -0600 Subject: [PATCH 27/35] docs: Make method reference format consistent in pytest plugin docs --- docs/pytest-plugin/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pytest-plugin/index.md b/docs/pytest-plugin/index.md index fcd48c6a5..d4cd5692a 100644 --- a/docs/pytest-plugin/index.md +++ b/docs/pytest-plugin/index.md @@ -74,7 +74,7 @@ You could also read the code and override {func}`server fixtures Date: Mon, 17 Feb 2025 08:37:40 -0600 Subject: [PATCH 28/35] docs: Add missing uv link definition --- docs/developing.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/developing.md b/docs/developing.md index f10ea4bc5..b1af6eb51 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -20,6 +20,7 @@ $ uv sync --all-extras --dev [installation documentation]: https://docs.astral.sh/uv/getting-started/installation/ [git]: https://git-scm.com/ +[uv]: https://github.com/astral-sh/uv Makefile commands prefixed with `watch_` will watch files and rerun. From 8c7533fc616c9b8824510bcbcf8eac121c1cc48e Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:38:12 -0600 Subject: [PATCH 29/35] docs: Make code block formatting consistent in version update example --- docs/developing.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/docs/developing.md b/docs/developing.md index b1af6eb51..294b67bc7 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -261,12 +261,14 @@ See https://github.com/tmux-python/tmuxp/issues/625. As of v0.10, [uv] handles virtualenv creation, package requirements, versioning, building, and publishing. Therefore there is no setup.py or requirements files. -Update `__version__` in `__about__.py` and `pyproject.toml`:: +Update `__version__` in `__about__.py` and `pyproject.toml`: - git commit -m 'build(libtmux): Tag v0.1.1' - git tag v0.1.1 - git push - git push --tags +```console +git commit -m 'build(libtmux): Tag v0.1.1' +git tag v0.1.1 +git push +git push --tags +``` [twine]: https://twine.readthedocs.io/ [uv]: https://github.com/astral-sh/uv From e0c3958b6053822981c0ce1a97317e26f4eadfd8 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:38:30 -0600 Subject: [PATCH 30/35] docs: Make code block formatting consistent in CHANGES example --- docs/developing.md | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/developing.md b/docs/developing.md index 294b67bc7..cd0a010f6 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -230,15 +230,17 @@ Let's assume we pick 0.9.1 `CHANGES`: Assure any PRs merged since last release are mentioned. Give a thank you to the contributor. Set the header with the new version and the date. Leave the "current" header and _Insert changes/features/fixes for next release here_ at -the top:: +the top: - current - ------- - - *Insert changes/features/fixes for next release here* +``` +current +------- +- *Insert changes/features/fixes for next release here* - libtmux 0.9.1 (2020-10-12) - -------------------------- - - :issue:`1`: Fix bug +libtmux 0.9.1 (2020-10-12) +-------------------------- +- :issue:`1`: Fix bug +``` `libtmux/__init__.py` and `__about__.py` - Set version From e8962ace81c64fe46e830650597f708fdf80ee0d Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:38:48 -0600 Subject: [PATCH 31/35] docs: Make server fixture reference consistent --- docs/pytest-plugin/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pytest-plugin/index.md b/docs/pytest-plugin/index.md index d4cd5692a..bbbdf446f 100644 --- a/docs/pytest-plugin/index.md +++ b/docs/pytest-plugin/index.md @@ -67,7 +67,7 @@ options: - Pass a `config_file` into {class}`~libtmux.Server` - Set the `HOME` directory to a local or temporary pytest path with a configuration file -You could also read the code and override {func}`server fixtures `'s in your own doctest. +You could also read the code and override {func}`server fixture ` in your own doctest. (custom_session_params)= From 3d636b13d71cab98e26b24a83a06a3de868277b5 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:39:35 -0600 Subject: [PATCH 32/35] docs: Make helper commands formatting consistent with console code blocks --- docs/developing.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/docs/developing.md b/docs/developing.md index cd0a010f6..e5c9690ec 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -85,11 +85,23 @@ $ make serve to start http server. -Helpers: `make build_docs`, `make serve_docs` +Helpers: +```console +$ make build_docs +$ make serve_docs +``` -Rebuild docs on file change: `make watch_docs` (requires [entr(1)]) +Rebuild docs on file change: +```console +$ make watch_docs +``` +(requires [entr(1)]) -Rebuild docs and run server via one terminal: `make dev_docs` (requires above, and a `make(1)` with +Rebuild docs and run server via one terminal: +```console +$ make dev_docs +``` +(requires above, and a `make(1)` with `-J` support, e.g. GNU Make) ## Linting From b57983b79b3b346966b26d16986d122609297731 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:39:53 -0600 Subject: [PATCH 33/35] docs: Make tmux(1) reference formatting consistent --- docs/pytest-plugin/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/pytest-plugin/index.md b/docs/pytest-plugin/index.md index bbbdf446f..cdcdf5a82 100644 --- a/docs/pytest-plugin/index.md +++ b/docs/pytest-plugin/index.md @@ -41,7 +41,7 @@ object lookups in the test grid. `pytest-tmux` works through providing {ref}`pytest fixtures ` - so read up on those! -The plugin's fixtures guarantee a fresh, headless `tmux(1)` server, session, window, or pane is +The plugin's fixtures guarantee a fresh, headless {command}`tmux(1)` server, session, window, or pane is passed into your test. (recommended-fixtures)= From 5e8ec6ea3fb3ff70d111142cfdb249eb871b5bc1 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:40:40 -0600 Subject: [PATCH 34/35] docs: Make entr(1) references consistent --- docs/developing.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/developing.md b/docs/developing.md index e5c9690ec..6fb2ef9f4 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -287,7 +287,6 @@ git push --tags [twine]: https://twine.readthedocs.io/ [uv]: https://github.com/astral-sh/uv [entr(1)]: http://eradman.com/entrproject/ -[`entr(1)`]: http://eradman.com/entrproject/ [ruff format]: https://docs.astral.sh/ruff/formatter/ [ruff]: https://ruff.rs [mypy]: http://mypy-lang.org/ From 733605950309c79dd0af3cc48717b12d4e0c9559 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 08:41:08 -0600 Subject: [PATCH 35/35] docs: Make make(1) reference formatting consistent --- docs/developing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developing.md b/docs/developing.md index 6fb2ef9f4..dcafc1f16 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -101,7 +101,7 @@ Rebuild docs and run server via one terminal: ```console $ make dev_docs ``` -(requires above, and a `make(1)` with +(requires above, and {command}`make(1)` with `-J` support, e.g. GNU Make) ## Linting