Skip to content

Commit 44dfa38

Browse files
committed
docs: Format with prettier
1 parent 6cbcfe7 commit 44dfa38

12 files changed

+22
-47
lines changed

docs/about.md

+13-16
Original file line numberDiff line numberDiff line change
@@ -67,39 +67,36 @@ libtmux uses `FORMATTERS` in tmux to give identity attributes to
6767
How is libtmux able to keep references to panes, windows and sessions?
6868

6969
> Tmux has unique ID's for sessions, windows and panes.
70-
>
70+
>
7171
> panes use `%`, such as `%1234`
72-
>
72+
>
7373
> windows use `@`, such as `@2345`
74-
>
74+
>
7575
> sessions use `$`, for money, such as `$`
76-
>
77-
How is libtmux able to handle windows with no names?
76+
>
77+
> How is libtmux able to handle windows with no names?
7878
7979
> Tmux provides `window_id` as a unique identifier.
80-
>
81-
What is a {pane,window}_index vs a {pane,window,session}_id?
80+
>
81+
> What is a {pane,window}\_index vs a {pane,window,session}\_id?
8282
8383
> Pane index refers to the order of a pane on the screen.
84-
>
84+
>
8585
> Window index refers to the # of the window in the session.
86-
>
87-
To assert pane, window and session data, libtmux will use
88-
{meth}`Server.list_sessions()`, {meth}`Session.list_windows()`,
89-
{meth}`Window.list_panes()` to update objects.
86+
>
87+
> To assert pane, window and session data, libtmux will use
88+
> {meth}`Server.list_sessions()`, {meth}`Session.list_windows()`,
89+
> {meth}`Window.list_panes()` to update objects.
9090
9191
## Naming conventions
9292

9393
Because this is a python abstraction and commands like `new-window`
94-
have dashes (-) replaced with underscores (_).
94+
have dashes (-) replaced with underscores (\_).
9595

9696
## Reference
9797

9898
- tmux docs <http://www.openbsd.org/cgi-bin/man.cgi?query=tmux&sektion=1>
9999
- tmux source code <http://sourceforge.net/p/tmux/tmux-code/ci/master/tree/>
100100

101101
[abstraction layer]: http://en.wikipedia.org/wiki/Abstraction_layer
102-
103102
[scope]: https://en.wikipedia.org/wiki/Variable_(computer_science)#Scope_and_extent
104-
105-

docs/api.md

-2
Original file line numberDiff line numberDiff line change
@@ -188,5 +188,3 @@
188188
```{eval-rst}
189189
.. autoclass:: libtmux.test.EnvironmentVarGuard
190190
```
191-
192-

docs/glossary.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# Glossary
44

55
```{eval-rst}
6-
.. glossary::
6+
.. glossary::
77
88
libtmux
99
Python library for interfacing with tmux through its objects.
@@ -66,5 +66,3 @@
6666
```
6767

6868
[kaptan on github]: https://github.com/emre/kaptan
69-
70-

docs/history.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,5 @@
55
```
66

77
```{include} ../CHANGES
8-
```
9-
108
9+
```

docs/index.md

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
# libtmux
44

55
```{include} ../README.md
6+
67
```
78

89
## Table of Contents

docs/panes.md

-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
- identified by `%`, e.g. `%313`
88

99
[pseudoterminal]: https://en.wikipedia.org/wiki/Pseudoterminal
10-
1110
[pty(4)]: https://www.freebsd.org/cgi/man.cgi?query=pty&sektion=4
1211

1312
```{eval-rst}
@@ -19,5 +18,3 @@
1918
:show-inheritance:
2019
:member-order: bysource
2120
```
22-
23-

docs/properties.md

-2
Original file line numberDiff line numberDiff line change
@@ -219,5 +219,3 @@ u'70'
219219
```
220220

221221
[formats]: http://man.openbsd.org/OpenBSD-5.9/man1/tmux.1#FORMATS
222-
223-

docs/quickstart.md

+2-7
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ First, we can grab a {class}`Server`.
9292
:::{note}
9393

9494
You can specify a `socket_name`, `socket_path` and `config_file`
95-
in your server object. `libtmux.Server(socket_name='mysocket')` is
95+
in your server object. `libtmux.Server(socket_name='mysocket')` is
9696
equivalent to `$ tmux -L mysocket`.
9797

9898
:::
@@ -338,7 +338,7 @@ As long as you have the object, or are iterating through a list of them, you can
338338
```
339339

340340
See the other window, notice that {meth}`Pane.send_keys` has " `echo hey`" written,
341-
*still in the prompt*. Note the leading space character so the command won't be added to the user's history. Use {}`pane.cmd('send-keys', text)` to send keys without this leading space.
341+
_still in the prompt_. Note the leading space character so the command won't be added to the user's history. Use {}`pane.cmd('send-keys', text)` to send keys without this leading space.
342342

343343
`enter=False` can be used to send keys without pressing return. In this case,
344344
you may leave it to the user to press return himself, or complete a command
@@ -367,11 +367,6 @@ and our [test suite][test suite] (see {ref}`developing`.)
367367
:::
368368

369369
[sliderepl]: http://discorporate.us/projects/sliderepl/
370-
371370
[workspacebuilder.py]: https://github.com/tmux-python/libtmux/blob/master/libtmux/workspacebuilder.py
372-
373371
[test suite]: https://github.com/tmux-python/libtmux/tree/master/tests
374-
375372
[ptpython]: https://github.com/jonathanslenders/ptpython
376-
377-

docs/servers.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
# Servers
44

5-
- identified by *socket path* and *socket name*
5+
- identified by _socket path_ and _socket name_
66
- may have >1 servers running of tmux at the same time.
77
- hold {ref}`Sessions` (which hold {ref}`Windows`, which hold
88
{ref}`Panes`)
@@ -19,5 +19,3 @@ when you first run tmux.
1919
:show-inheritance:
2020
:member-order: bysource
2121
```
22-
23-

docs/sessions.md

-2
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,3 @@
1515
:show-inheritance:
1616
:member-order: bysource
1717
```
18-
19-

docs/traversal.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
libtmux convenient access to move around the hierachy of sessions,
66
windows and panes in tmux.
77

8-
this is done by libtmux's object abstraction of {}`target`_s (the `-t`
8+
this is done by libtmux's object abstraction of {}`target`\_s (the `-t`
99
command) and the permanent internal ID's tmux gives to objects.
1010

1111
open two terminals:
@@ -86,8 +86,8 @@ Window(@1 1:libtmux, Session($0 libtmux))
8686

8787
grab the currently focused window from session:
8888

89-
> >>> session.attached_window
90-
> Window(@2 2:docs, Session($0 libtmux))grab the currently focused {class}`Pane` from session:
89+
> > > > session.attached_window
90+
> > > > Window(@2 2:docs, Session($0 libtmux))grab the currently focused {class}`Pane` from session:
9191
9292
```
9393
>>> session.attached_pane
@@ -111,5 +111,3 @@ Window(@2 2:docs, Session($0 libtmux))
111111
```
112112

113113
[target]: http://man.openbsd.org/OpenBSD-5.9/man1/tmux.1#COMMANDS
114-
115-

docs/windows.md

-2
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,3 @@
1919
:show-inheritance:
2020
:member-order: bysource
2121
```
22-
23-

0 commit comments

Comments
 (0)