Skip to content

Commit ee025d2

Browse files
committed
Clean up docs with trailing while spaces, long lines and inconsistent section headers.
1 parent 1e6eb33 commit ee025d2

File tree

5 files changed

+18
-17
lines changed

5 files changed

+18
-17
lines changed

doc/about.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ Built on a object relational mapper for tmux. tmux users can reload common
1212
workspaces from YAML, JSON and :py:obj:`dict` configurations like
1313
`tmuxinator`_ and `teamocil`_.
1414

15-
tmuxp is used by developers for tmux automation at great companies like
15+
tmuxp is used by developers for tmux automation at great companies like
1616
`Bugsnag`_, `Pragmatic Coders`_ and many others.
1717

1818
To jump right in, see :ref:`quickstart` and :ref:`examples`.
1919

2020
Interested in some kung-fu or joining the effort? :ref:`api` and
2121
:ref:`developing`.
2222

23-
`MIT-licensed`_. Code on `github
23+
`MIT-licensed`_. Code on `github
2424
<http://github.com/tmux-python/tmuxp>`_.
2525

2626
.. _Bugsnag: https://blog.bugsnag.com/benefits-of-using-tmux/
@@ -84,7 +84,7 @@ See :ref:`libtmux's internals <libtmux:Internals>`.
8484
**Conversion** ``$ tmuxp convert <filename>`` can convert files to and
8585
from JSON and YAML.
8686

87-
.. [1] While freezing and importing sessions is a great way to save time,
87+
.. [1] While freezing and importing sessions is a great way to save time,
8888
tweaking will probably be required - There is no substitute to a
8989
config made with love.
9090

doc/about_tmux.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -154,10 +154,10 @@ sandwich, and re-(attach), all applications are still running!
154154
+--------+--------+
155155
| $ bash | $ bash |
156156
| | |
157-
| | | /------------\
158-
+--------+--------+ --> | detach |
159-
| $ vim | $ bash | | 'Ctrl-b b' |
160-
| | | \------------/
157+
| | | /------------\
158+
+--------+--------+ --> | detach |
159+
| $ vim | $ bash | | 'Ctrl-b b' |
160+
| | | \------------/
161161
| | | |
162162
+--------+--------+ |
163163
/------------------/
@@ -208,7 +208,7 @@ Applications running on a remote server can be launched inside of a tmux
208208
session, detached, and reattached next timeyour `"train of thought"`_ and
209209
work.
210210

211-
Multitasking. Preserving the thinking you have.
211+
Multitasking. Preserving the thinking you have.
212212

213213
.. _"train of thought": http://en.wikipedia.org/wiki/Train_of_thought
214214

@@ -258,7 +258,7 @@ That's all it takes to launch yourself into a tmux session.
258258
Running ``$ tmux list-sessions`` or any other command for listing tmux
259259
entities (such as ``$ tmux list-windows`` or ``$ tmux list-panes``).
260260
This can generate the error "failed to connect to server".
261-
261+
262262
This could be because:
263263

264264
- tmux server has killed its' last session, killing the server.
@@ -633,7 +633,7 @@ Short cut Action
633633
``M-o`` Rotate the panes in the current window backwards.
634634
``M-p`` Move to the previous window with a bell or activity
635635
marker.
636-
``C-Up, C-Down`` Resize the current pane in steps of one cell.
636+
``C-Up, C-Down`` Resize the current pane in steps of one cell.
637637
``C-Left, C-Right``
638638
``M-Up, M-Down`` Resize the current pane in steps of five cells.
639639
``M-Left, M-Right``

doc/developing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,7 @@ Multiple can be separated by spaces:
146146
.. _test_builder_visually:
147147

148148
Visual testing
149-
~~~~~~~~~~~~~~
149+
--------------
150150

151151
You can watch tmux testsuite build sessions visually by keeping a client
152152
open in a separate terminal.

doc/examples.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -183,12 +183,12 @@ In this case of this example, assuming the username "user"::
183183

184184
$ MY_ENV_VAR=foo tmuxp load examples/env-variables.yaml
185185

186-
and your session name will be ``session - user (foo)``.
186+
and your session name will be ``session - user (foo)``.
187187

188-
Shell variables in ``shell_command`` do not support this type of
188+
Shell variables in ``shell_command`` do not support this type of
189189
concatenation. ``shell_command`` and ``shell_command_before`` both
190190
support normal shell variables, since they are sent into panes
191-
automatically via ``send-key`` in ``tmux(1)``. See ``ls $PWD`` in
191+
automatically via ``send-key`` in ``tmux(1)``. See ``ls $PWD`` in
192192
example.
193193

194194
If you have a special case and would like to see behavior changed,
@@ -369,7 +369,7 @@ A successful script will exit with a status of ``0``.
369369
Important: the script file must be chmod executable ``+x`` or ``755``.
370370

371371
Run a python script (and check for it's return code), the script is
372-
*relative to the ``.tmuxp.yaml``'s root* (Windows and panes omitted in
372+
*relative to the ``.tmuxp.yaml``'s root* (Windows and panes omitted in
373373
this example):
374374

375375
.. code-block:: yaml
@@ -450,7 +450,8 @@ packages are installed:
450450
- blank
451451
- pipenv run ./manage.py runserver
452452
453-
You can also source yourself into the virtual environment using ``shell_command_before``:
453+
You can also source yourself into the virtual environment using
454+
``shell_command_before``:
454455

455456
.. code-block:: yaml
456457

doc/glossary.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Glossary
3737

3838
Session
3939
Inside a tmux :term:`server`.
40-
40+
4141
The session has 1 or more :term:`Window`. The bottom bar in tmux
4242
show a list of windows. Normally they can be navigated with
4343
``Ctrl-a [0-9]``, ``Ctrl-a n`` and ``Ctrl-a p``.

0 commit comments

Comments
 (0)