Skip to content

docs: Fix typos #884

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 1 commit into from
Sep 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions CHANGES
Original file line number Diff line number Diff line change
Expand Up @@ -1284,7 +1284,7 @@ This will be the last Python 2.7 release of tmuxp. Bug fixes for python
- #110 de-vendorize [colorama][colorama]. Thanks [@marbu][@marbu].
- #109 fix failure of test_pane_order on fedora machines from
[@marbu][@marbu]
- #105 append `.txt` extension to manuals (repo ony)
- #105 append `.txt` extension to manuals (repo only)
from [@yegortimoshenko][@yegortimoshenko].
- #107 Fix Server.attached_sessions return type by
[@thomasballinger][@thomasballinger].
Expand Down Expand Up @@ -1445,7 +1445,7 @@ This will be the last Python 2.7 release of tmuxp. Bug fixes for python
## tmuxp 0.1-rc8 (2013-12-17)

- `unicode_literals`
- Move py2/py3 compliancy code to `_compat`.
- Move py2/py3 compliance code to `_compat`.

## tmuxp 0.1-rc7 (2013-12-07)

Expand Down Expand Up @@ -1690,7 +1690,7 @@ This will be the last Python 2.7 release of tmuxp. Bug fixes for python
- fix bug where `-v` and `--version` wouldn't print version.
- property handle case where no tmux server exists when
`attach-session` or `kill-session` is used.
- test fixtures and inital work for importing
- test fixtures and initial work for importing
[tmuxinator][tmuxinator] and [teamocil][teamocil] configs

## tmuxp 0.1-dev (2013-10-24)
Expand Down Expand Up @@ -1742,11 +1742,11 @@ This will be the last Python 2.7 release of tmuxp. Bug fixes for python
{meth}`Server.__list_sessions()` exists to keep the command layered so
it can be tested against in a matrix with travis and compatibility
methods can be made.
- {class}`Session` now has @proprety {meth}`Session.windows` returning a
- {class}`Session` now has @property {meth}`Session.windows` returning a
list of {class}`Window` objects via {meth}`Session.list_windows()`.
@property {meth}`Session._windows` to {meth}`Session._list_windows()`
to return a list of dicts without making objects.
- {class}`Window` now has @proprety {meth}`Window.panes` returning a
- {class}`Window` now has @property {meth}`Window.panes` returning a
list of {class}`Pane` objects via {meth}`Window.list_panes()`.
@property {meth}`Window._panes` to {meth}`Window._list_panes()`
to return a list of dicts without making objects.
Expand Down
2 changes: 1 addition & 1 deletion MIGRATION
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ well.

API changes can be painful.

If we can do something to draw the sting, we'll do it. We're taking a balanced approach. That's why these notes are here!
If we can do something to draw the string, we'll do it. We're taking a balanced approach. That's why these notes are here!

(Please pin the package. 🙏)

Expand Down
6 changes: 3 additions & 3 deletions docs/_ext/aafig.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
sphinxcontrib.aafig
~~~~~~~~~~~~~~~~~~~

Allow embeded ASCII art to be rendered as nice looking images
Allow embedded ASCII art to be rendered as nice looking images
using the aafigure reStructuredText extension.

See the README file for details.
Expand Down Expand Up @@ -98,7 +98,7 @@ def render_aafig_images(app, doctree):
if aafigure is None:
logger.warn(
"aafigure module not installed, ASCII art images "
"will be redered as literal text"
"will be rendered as literal text"
)
for img in doctree.traverse(nodes.image):
if not hasattr(img, "aafig"):
Expand Down Expand Up @@ -160,7 +160,7 @@ def render_aafigure(app, text, options):
"aafig: the builder format %s is not officially "
"supported, aafigure images could not work. "
"Please report problems and working builder to "
"avoid this warning inthe future" % app.builder.format
"avoid this warning in the future" % app.builder.format
)
relfn = fname
outfn = path.join(app.builder.outdir, fname)
Expand Down
18 changes: 9 additions & 9 deletions docs/_static/img/tmuxp.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/about.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ format [^id4]. See {ref}`cli-freeze`.

**JSON config** JSON config support. See {ref}`Examples`.

**ORM-based API** via [libtmux] - Utilitizes tmux >= 1.8's unique ID's for
**ORM-based API** via [libtmux] - Utilizes tmux >= 1.8's unique ID's for
panes, windows and sessions to create an object relational view of the tmux
{class}`~libtmux.Server`, its {class}`~libtmux.Session`,
{class}`~libtmux.Window`, and {class}`~libtmux.Pane`.
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/ls.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# tmuxp ls

List sesssions.
List sessions.

```{eval-rst}
.. argparse::
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
# sphinxext.opengraph
ogp_site_url = about["__docs__"]
ogp_image = "_static/img/icons/icon-192x192.png"
ogp_desscription_length = about["__description__"]
ogp_description_length = about["__description__"]
ogp_site_name = about["__title__"]

# sphinx-copybutton
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ python environment. A plugin interface is provided by tmuxp to inherit.
[poetry][poetry] is the chosen python package manager for tmuxp. It is highly
suggested to use it when developing plugins; however, `pip` will work
just as well. Only one of the configuration files is needed for the packaging
tool that the package developer desides to use.
tool that the package developer decides to use.

```console

Expand Down
10 changes: 5 additions & 5 deletions tests/cli/test_shell.py
Original file line number Diff line number Diff line change
Expand Up @@ -139,27 +139,27 @@ def test_shell(
(
[
"-L{SOCKET_NAME}",
"nonexistant_session",
"nonexistent_session",
"-c",
"print(str(server.socket_name))",
],
[],
{},
{"session_name": "nonexistant_session"},
{"session_name": "nonexistent_session"},
exc.TmuxpException,
"Session not found: nonexistant_session",
"Session not found: nonexistent_session",
),
(
[
"-L{SOCKET_NAME}",
"{SESSION_NAME}",
"nonexistant_window",
"nonexistent_window",
"-c",
"print(str(server.socket_name))",
],
[],
{},
{"window_name": "nonexistant_window"},
{"window_name": "nonexistent_window"},
exc.TmuxpException,
"Window not found: {WINDOW_NAME}",
),
Expand Down
4 changes: 2 additions & 2 deletions tests/fixtures/workspace/expand1.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
{"shell_command": ["vim"]},
{"shell_command": 'cowsay "hey"'},
],
"layout": "main-verticle",
"layout": "main-vertical",
},
{
"window_name": "logging",
Expand Down Expand Up @@ -42,7 +42,7 @@ def after_workspace():
{"shell_command": [{"cmd": "vim"}]},
{"shell_command": [{"cmd": 'cowsay "hey"'}]},
],
"layout": "main-verticle",
"layout": "main-vertical",
},
{
"window_name": "logging",
Expand Down
2 changes: 1 addition & 1 deletion tests/fixtures/workspace/sample_workspace.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
{"start_directory": "~", "shell_command": ["vim"]},
{"shell_command": ['cowsay "hey"']},
],
"layout": "main-verticle",
"layout": "main-vertical",
},
{
"window_name": "logging",
Expand Down
6 changes: 3 additions & 3 deletions tests/fixtures/workspace/shell_command_before.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"shell_command": ['cowsay "hey"'],
},
],
"layout": "main-verticle",
"layout": "main-vertical",
},
{
"shell_command_before": "rbenv local 2.0.0-p0",
Expand Down Expand Up @@ -58,7 +58,7 @@ def config_expanded() -> Dict[str, Any]:
"shell_command": [{"cmd": 'cowsay "hey"'}],
},
],
"layout": "main-verticle",
"layout": "main-vertical",
},
{
"shell_command_before": {
Expand Down Expand Up @@ -119,7 +119,7 @@ def config_after() -> Dict[str, Any]:
],
},
],
"layout": "main-verticle",
"layout": "main-vertical",
},
{
"shell_command_before": {
Expand Down
4 changes: 2 additions & 2 deletions tests/fixtures/workspace/trickle.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
{"shell_command": [{"cmd": "vim"}]},
{"shell_command": [{"cmd": 'cowsay "hey"'}]},
],
"layout": "main-verticle",
"layout": "main-vertical",
},
{
"window_name": "logging",
Expand All @@ -33,7 +33,7 @@
{"shell_command": [{"cmd": "vim"}]},
{"shell_command": [{"cmd": 'cowsay "hey"'}]},
],
"layout": "main-verticle",
"layout": "main-vertical",
},
{
"start_directory": "~",
Expand Down
4 changes: 2 additions & 2 deletions tests/workspace/test_config.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ def test_workspace_expand2(config_fixture: "WorkspaceTestData"):
"window_name": "editor",
"start_directory": "~",
"panes": [{"shell_command": ["vim"]}, {"shell_command": ['cowsay "hey"']}],
"layout": "main-verticle",
"layout": "main-vertical",
},
{
"window_name": "logging",
Expand All @@ -118,7 +118,7 @@ def test_workspace_expand2(config_fixture: "WorkspaceTestData"):
"window_name": "editor",
"start_directory": "~",
"panes": [{"shell_command": ["vim"]}, {"shell_command": ['cowsay "hey"']}],
"layout": "main-verticle",
"layout": "main-vertical",
},
{
"window_name": "logging",
Expand Down
4 changes: 2 additions & 2 deletions tests/workspace/test_freezer.py
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ def test_freeze_config(session):
"shell_command": ["top"],
"window_name": "editor",
"panes": [{"shell_command": ["vim"]}, {"shell_command": ['cowsay "hey"']}],
"layout": "main-verticle",
"layout": "main-vertical",
},
{
"window_name": "logging",
Expand All @@ -68,7 +68,7 @@ def test_freeze_config(session):
"shell_command": "top",
"window_name": "editor",
"panes": ["vim", 'cowsay "hey"'],
"layout": "main-verticle",
"layout": "main-vertical",
},
{"window_name": "logging", "panes": ["tail -F /var/log/syslog"]},
{"options": {"automatic-rename": True}, "panes": ["htop"]},
Expand Down