diff --git a/docs/about.md b/docs/about.md index 3dc6e1fc97..71007d950c 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]. @@ -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. diff --git a/docs/about_tmux.md b/docs/about_tmux.md index 7aff532bd6..e69c2268f9 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:: @@ -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. @@ -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). @@ -254,10 +254,10 @@ 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. +- tmux has not been launched yet at all. ::: @@ -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`. diff --git a/docs/cli/load.md b/docs/cli/load.md index d5a59990b9..d1d515ab8c 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 diff --git a/docs/cli/shell.md b/docs/cli/shell.md index b202fdaae8..58c2d7ebb0 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 ` diff --git a/docs/configuration/examples.md b/docs/configuration/examples.md index adf8efae68..97b2a369a1 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 diff --git a/docs/configuration/index.md b/docs/configuration/index.md index b23d956b89..aa59b017ee 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 diff --git a/docs/developing.md b/docs/developing.md index 774357f00c..95f4dd52f8 100644 --- a/docs/developing.md +++ b/docs/developing.md @@ -105,8 +105,8 @@ $ 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 +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. @@ -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: diff --git a/docs/plugins/index.md b/docs/plugins/index.md index 06ef765dbd..0276d66e64 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. diff --git a/docs/quickstart.md b/docs/quickstart.md index fe78bf60fe..239fd22252 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