Skip to content

Doc improvements #963

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Feb 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -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].

Expand Down Expand Up @@ -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.
Expand Down
12 changes: 6 additions & 6 deletions docs/about_tmux.md
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down Expand Up @@ -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.
Expand All @@ -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).
Expand Down Expand Up @@ -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.

:::

Expand 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`.
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/load.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/shell.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <libtmux.Server>`,
{class}`session <libtmux.Session>`, {class}`window <libtmux.Window>`
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/developing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down