From ab61c4212d7d063bd45d36653e6ed354200cc8ac Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:41:18 -0600 Subject: [PATCH 01/17] docs: Fix grammar - use 'an' before 'object' 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 3dc6e1fc970..3bc94bc1f9a 100644 --- a/docs/about.md +++ b/docs/about.md @@ -8,7 +8,7 @@ tmuxp helps you manage tmux workspaces. -Built on a object relational mapper for tmux. tmux users can reload common +Built on an object relational mapper for tmux. tmux users can reload common workspaces from YAML, JSON and {py:obj}`dict` workspace files like [tmuxinator] and [teamocil]. From 1c95567f0f438ab3b60d60835c245f21defb0bf0 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:41:33 -0600 Subject: [PATCH 02/17] docs: Fix PATH environment variable formatting 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 774357f00c4..f7087f4b8bc 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -106,7 +106,7 @@ $ tmuxp [pytest] is used for tests. As you seen above, the `tmuxp` command will now be available to you, -since you are in the virtual environment, your {}`PATH` environment was +since you are in the virtual environment, your `PATH` environment was updated to include a special version of `python` inside your `.venv` folder with its own packages. From 39334922d47aec7dfee8aa5c2cc7b4774efef0f6 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:41:46 -0600 Subject: [PATCH 03/17] docs: Fix grammar in developing.md - 'As you seen' to 'As you've seen' --- docs/developing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/developing.md b/docs/developing.md index f7087f4b8bc..f60925f77a5 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -105,7 +105,7 @@ $ tmuxp [pytest] is used for tests. -As you seen above, the `tmuxp` command will now be available to you, +As you've seen above, the `tmuxp` command will now be available to you, since you are in the virtual environment, your `PATH` environment was updated to include a special version of `python` inside your `.venv` folder with its own packages. From 9699aef08e44d6e48fe7a5ac2ed894e0b2a76e32 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:42:44 -0600 Subject: [PATCH 04/17] docs: Remove duplicate word 'available' 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 f60925f77a5..95f4dd52f8b 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -248,7 +248,7 @@ This requires [`entr(1)`]. ::: -Install [entr]. Packages are available available on most Linux and BSD +Install [entr]. Packages are available on most Linux and BSD variants, including Debian, Ubuntu, FreeBSD, OS X. To run all tests upon editing any `.py` file: From e402b6742892a19390519ed92f8a234638971026 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:42:57 -0600 Subject: [PATCH 05/17] docs: Change 'Assure' to 'Ensure' in quickstart.md for better word choice --- docs/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index fe78bf60fea..239fd22252a 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -4,7 +4,7 @@ ## Installation -Assure you have at least tmux **>= 1.8** and python **>= 3.7**. +Ensure you have at least tmux **>= 1.8** and python **>= 3.7**. ```console $ pip install --user tmuxp From e17974cef196a044f6756725d376e7c4f3524538 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:43:10 -0600 Subject: [PATCH 06/17] docs: Fix verb agreement for plural subjects 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 3bc94bc1f9a..71007d950c5 100644 --- a/docs/about.md +++ b/docs/about.md @@ -46,7 +46,7 @@ tmuxinator may have support for earlier versions. ### Differences -**Programming Language** python. teamocil and tmuxinator uses ruby. +**Programming Language** python. teamocil and tmuxinator use ruby. **Workspace building process** teamocil and tmuxinator process configs directly shell commands. tmuxp processes configuration via ORM layer. From 2b9629b1f4ac6fc12d9394d9a742cbbcd30d06b7 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:43:33 -0600 Subject: [PATCH 07/17] docs: Fix spacing in 'next timeyour' to 'next time your' in about_tmux.md --- docs/about_tmux.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about_tmux.md b/docs/about_tmux.md index 7aff532bd6f..bc697a0616f 100644 --- a/docs/about_tmux.md +++ b/docs/about_tmux.md @@ -209,7 +209,7 @@ a sandwich, and re-(attach), all applications are still running! - Programmers like to have an editor open with a CLI nearby. Applications running on a remote server can be launched inside of a tmux -session, detached, and reattached next timeyour ["train of +session, detached, and reattached next time your ["train of thought"](http://en.wikipedia.org/wiki/Train_of_thought) and work. Multitasking. Preserving the thinking you have. From 02370218d0e88872050feb7c8ce8c31fafb35fdf Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:43:47 -0600 Subject: [PATCH 08/17] docs: Fix incorrect possessive 'its'' to 'its' in about_tmux.md --- docs/about_tmux.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about_tmux.md b/docs/about_tmux.md index bc697a0616f..c38f5b45067 100644 --- a/docs/about_tmux.md +++ b/docs/about_tmux.md @@ -254,7 +254,7 @@ This can generate the error "failed to connect to server". This could be because: -- tmux server has killed its' last session, killing the server. +- tmux server has killed its last session, killing the server. - tmux server has encountered a crash. (tmux is highly stable, this will rarely happen) - tmux has not be launched yet at all. From 6300ca32ef720646e0dffda8357a921ae4a2ea62 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:44:32 -0600 Subject: [PATCH 09/17] docs: Fix plural form 'manys' to 'many' in about_tmux.md --- docs/about_tmux.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about_tmux.md b/docs/about_tmux.md index c38f5b45067..5ebca36fb2b 100644 --- a/docs/about_tmux.md +++ b/docs/about_tmux.md @@ -111,7 +111,7 @@ One screen can be used to edit a file, and another may be used to +--------+--------+ ``` -tmux supports as manys terminals as you want. +tmux supports as many terminals as you want. ```{eval-rst} .. aafig:: From c285028230a63ae6fc2f3d608b7672cb3b35c2e1 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:44:47 -0600 Subject: [PATCH 10/17] docs: Fix verb form 'be' to 'been' in about_tmux.md --- docs/about_tmux.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about_tmux.md b/docs/about_tmux.md index 5ebca36fb2b..02784f03af4 100644 --- a/docs/about_tmux.md +++ b/docs/about_tmux.md @@ -257,7 +257,7 @@ This could be because: - tmux server has killed its last session, killing the server. - tmux server has encountered a crash. (tmux is highly stable, this will rarely happen) -- tmux has not be launched yet at all. +- tmux has not been launched yet at all. ::: From 8f87a793b51bf45d29286b653382d33089a7b4d8 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:45:06 -0600 Subject: [PATCH 11/17] docs: Add missing article 'a' before 'second' in about_tmux.md --- docs/about_tmux.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about_tmux.md b/docs/about_tmux.md index 02784f03af4..9ee5ab93f49 100644 --- a/docs/about_tmux.md +++ b/docs/about_tmux.md @@ -270,7 +270,7 @@ carefully**, then try it yourself. First, you press the _prefix_ key. This is `C-b` by default. -Release. Then pause. For less than second. Then type what's next. +Release. Then pause. For less than a second. Then type what's next. `C-b o` means: Press `Ctrl` and `b` at the same time. Release, Then press `o`. From b3c9a91bfcff977e147e833163ab1a9d699bce5d Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:49:22 -0600 Subject: [PATCH 12/17] docs: that -> the about_tmux.md --- docs/about_tmux.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/about_tmux.md b/docs/about_tmux.md index 9ee5ab93f49..e69c2268f98 100644 --- a/docs/about_tmux.md +++ b/docs/about_tmux.md @@ -226,7 +226,7 @@ This documentation is written for version **1.8**. It's important that you have the latest stable release of tmux. The latest stable version is viewable on the [tmux homepage](http://tmux.sourceforge.net/). -**Mac OS X** users may install that latest stable version of tmux +**Mac OS X** users may install the latest stable version of tmux through [MacPorts](http://www.macports.org/), [fink](http://fink.thetis.ig42.org/) or [Homebrew](http://www.brew.sh) (aka brew). From 4c9c66d7834920719144355e1286202a796682ea Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:52:23 -0600 Subject: [PATCH 13/17] docs: Fix verb agreement - 'will offers' to 'will offer' in configuration/index.md --- docs/configuration/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/index.md b/docs/configuration/index.md index b23d956b89a..aa59b017ee0 100644 --- a/docs/configuration/index.md +++ b/docs/configuration/index.md @@ -18,7 +18,7 @@ Once you have `tmuxp` installed alongside tmux, you can load a workspace with: $ tmuxp load ./path/to/file ``` -tmuxp will offers to assist when: +tmuxp will offer to assist when: - _Session already exists_: tmuxp will prompt you to re-attach. It does this by checking if the workspace's `session_name` matches a session already From 421bbe550119fa09e4f76af5659ad0549a5fc9f6 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:52:44 -0600 Subject: [PATCH 14/17] docs: Remove extra word 'to' in examples.md --- docs/configuration/examples.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/examples.md b/docs/configuration/examples.md index adf8efae681..97b2a369a16 100644 --- a/docs/configuration/examples.md +++ b/docs/configuration/examples.md @@ -4,7 +4,7 @@ ## Short hand / inline style -tmuxp has a short-hand syntax to for those who wish to keep their workspace +tmuxp has a short-hand syntax for those who wish to keep their workspace punctual. ::::{sidebar} short hand From 5c4a02994b78916cacb7e9587ca6605d61275d94 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:53:07 -0600 Subject: [PATCH 15/17] docs: Add missing article 'a' before 'class' in plugins/index.md --- docs/plugins/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/plugins/index.md b/docs/plugins/index.md index 06ef765dbd4..0276d66e643 100644 --- a/docs/plugins/index.md +++ b/docs/plugins/index.md @@ -32,7 +32,7 @@ your tmuxp workspace file. ## Developing a Plugin -tmuxp expects all plugins to be class within a python submodule named +tmuxp expects all plugins to be a class within a python submodule named `plugin` that is within a python module that is installed in the local python environment. A plugin interface is provided by tmuxp to inherit. From 59462c9265314963705c29dd0d24f344cde49a92 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:57:45 -0600 Subject: [PATCH 16/17] docs: Add missing article 'the' before 'client' in cli/load.md --- docs/cli/load.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cli/load.md b/docs/cli/load.md index d5a59990b90..d1d515ab8c7 100644 --- a/docs/cli/load.md +++ b/docs/cli/load.md @@ -98,7 +98,7 @@ Or (a)ppend windows in the current active session? All of these options can be preselected to skip the prompt: -- Attach / open client after load: +- Attach / open the client after load: ```console $ tmuxp load -y config From 0b9235403543680c226f6b013ebd76a0b3c28156 Mon Sep 17 00:00:00 2001 From: Tony Narlock Date: Mon, 17 Feb 2025 06:57:59 -0600 Subject: [PATCH 17/17] docs: Capitalize 'Python' in cli/shell.md --- docs/cli/shell.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/cli/shell.md b/docs/cli/shell.md index b202fdaae89..58c2d7ebb09 100644 --- a/docs/cli/shell.md +++ b/docs/cli/shell.md @@ -24,7 +24,7 @@ $ tmuxp shell -c 'python code' ## Guide -Launch into a python console with [libtmux] objects. Compare to django's shell. +Launch into a Python console with [libtmux] objects. Compare to django's shell. Automatically preloads current tmux {class}`server `, {class}`session `, {class}`window `