Skip to content

Commit 5fbc021

Browse files
authored
Docs: Typo fixes (#963)
* docs: Fix grammar - use 'an' before 'object' in about.md * docs: Fix PATH environment variable formatting in developing.md * docs: Fix grammar in developing.md - 'As you seen' to 'As you've seen' * docs: Remove duplicate word 'available' in developing.md * docs: Change 'Assure' to 'Ensure' in quickstart.md for better word choice * docs: Fix verb agreement for plural subjects in about.md * docs: Fix spacing in 'next timeyour' to 'next time your' in about_tmux.md * docs: Fix incorrect possessive 'its'' to 'its' in about_tmux.md * docs: Fix plural form 'manys' to 'many' in about_tmux.md * docs: Fix verb form 'be' to 'been' in about_tmux.md * docs: Add missing article 'a' before 'second' in about_tmux.md * docs: that -> the about_tmux.md * docs: Fix verb agreement - 'will offers' to 'will offer' in configuration/index.md * docs: Remove extra word 'to' in examples.md * docs: Add missing article 'a' before 'class' in plugins/index.md * docs: Add missing article 'the' before 'client' in cli/load.md * docs: Capitalize 'Python' in cli/shell.md
1 parent 831780a commit 5fbc021

File tree

9 files changed

+17
-17
lines changed

9 files changed

+17
-17
lines changed

docs/about.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
tmuxp helps you manage tmux workspaces.
1010

11-
Built on a object relational mapper for tmux. tmux users can reload common
11+
Built on an object relational mapper for tmux. tmux users can reload common
1212
workspaces from YAML, JSON and {py:obj}`dict` workspace files like
1313
[tmuxinator] and [teamocil].
1414

@@ -46,7 +46,7 @@ tmuxinator may have support for earlier versions.
4646

4747
### Differences
4848

49-
**Programming Language** python. teamocil and tmuxinator uses ruby.
49+
**Programming Language** python. teamocil and tmuxinator use ruby.
5050

5151
**Workspace building process** teamocil and tmuxinator process configs
5252
directly shell commands. tmuxp processes configuration via ORM layer.

docs/about_tmux.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ One screen can be used to edit a file, and another may be used to
111111
+--------+--------+
112112
```
113113

114-
tmux supports as manys terminals as you want.
114+
tmux supports as many terminals as you want.
115115

116116
```{eval-rst}
117117
.. aafig::
@@ -209,7 +209,7 @@ a sandwich, and re-(attach), all applications are still running!
209209
- Programmers like to have an editor open with a CLI nearby.
210210

211211
Applications running on a remote server can be launched inside of a tmux
212-
session, detached, and reattached next timeyour ["train of
212+
session, detached, and reattached next time your ["train of
213213
thought"](http://en.wikipedia.org/wiki/Train_of_thought) and work.
214214

215215
Multitasking. Preserving the thinking you have.
@@ -226,7 +226,7 @@ This documentation is written for version **1.8**. It's important that
226226
you have the latest stable release of tmux. The latest stable version is
227227
viewable on the [tmux homepage](http://tmux.sourceforge.net/).
228228

229-
**Mac OS X** users may install that latest stable version of tmux
229+
**Mac OS X** users may install the latest stable version of tmux
230230
through [MacPorts](http://www.macports.org/),
231231
[fink](http://fink.thetis.ig42.org/) or [Homebrew](http://www.brew.sh)
232232
(aka brew).
@@ -254,10 +254,10 @@ This can generate the error "failed to connect to server".
254254

255255
This could be because:
256256

257-
- tmux server has killed its' last session, killing the server.
257+
- tmux server has killed its last session, killing the server.
258258
- tmux server has encountered a crash. (tmux is highly stable,
259259
this will rarely happen)
260-
- tmux has not be launched yet at all.
260+
- tmux has not been launched yet at all.
261261

262262
:::
263263

@@ -270,7 +270,7 @@ carefully**, then try it yourself.
270270

271271
First, you press the _prefix_ key. This is `C-b` by default.
272272

273-
Release. Then pause. For less than second. Then type what's next.
273+
Release. Then pause. For less than a second. Then type what's next.
274274

275275
`C-b o` means: Press `Ctrl` and `b` at the same time. Release, Then
276276
press `o`.

docs/cli/load.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ Or (a)ppend windows in the current active session?
9898

9999
All of these options can be preselected to skip the prompt:
100100

101-
- Attach / open client after load:
101+
- Attach / open the client after load:
102102

103103
```console
104104
$ tmuxp load -y config

docs/cli/shell.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ $ tmuxp shell -c 'python code'
2424

2525
## Guide
2626

27-
Launch into a python console with [libtmux] objects. Compare to django's shell.
27+
Launch into a Python console with [libtmux] objects. Compare to django's shell.
2828

2929
Automatically preloads current tmux {class}`server <libtmux.Server>`,
3030
{class}`session <libtmux.Session>`, {class}`window <libtmux.Window>`

docs/configuration/examples.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Short hand / inline style
66

7-
tmuxp has a short-hand syntax to for those who wish to keep their workspace
7+
tmuxp has a short-hand syntax for those who wish to keep their workspace
88
punctual.
99

1010
::::{sidebar} short hand

docs/configuration/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Once you have `tmuxp` installed alongside tmux, you can load a workspace with:
1818
$ tmuxp load ./path/to/file
1919
```
2020

21-
tmuxp will offers to assist when:
21+
tmuxp will offer to assist when:
2222

2323
- _Session already exists_: tmuxp will prompt you to re-attach. It does this
2424
by checking if the workspace's `session_name` matches a session already

docs/developing.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -105,8 +105,8 @@ $ tmuxp
105105

106106
[pytest] is used for tests.
107107

108-
As you seen above, the `tmuxp` command will now be available to you,
109-
since you are in the virtual environment, your {}`PATH` environment was
108+
As you've seen above, the `tmuxp` command will now be available to you,
109+
since you are in the virtual environment, your `PATH` environment was
110110
updated to include a special version of `python` inside your `.venv`
111111
folder with its own packages.
112112

@@ -248,7 +248,7 @@ This requires [`entr(1)`].
248248

249249
:::
250250

251-
Install [entr]. Packages are available available on most Linux and BSD
251+
Install [entr]. Packages are available on most Linux and BSD
252252
variants, including Debian, Ubuntu, FreeBSD, OS X.
253253

254254
To run all tests upon editing any `.py` file:

docs/plugins/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ your tmuxp workspace file.
3232

3333
## Developing a Plugin
3434

35-
tmuxp expects all plugins to be class within a python submodule named
35+
tmuxp expects all plugins to be a class within a python submodule named
3636
`plugin` that is within a python module that is installed in the local
3737
python environment. A plugin interface is provided by tmuxp to inherit.
3838

docs/quickstart.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Installation
66

7-
Assure you have at least tmux **>= 1.8** and python **>= 3.7**.
7+
Ensure you have at least tmux **>= 1.8** and python **>= 3.7**.
88

99
```console
1010
$ pip install --user tmuxp

0 commit comments

Comments
 (0)