From ec31908ff55f2e66a9fd18db77534a9827e0633b Mon Sep 17 00:00:00 2001 From: Kian-Meng Ang Date: Sat, 2 Sep 2023 18:29:32 +0800 Subject: [PATCH] docs: Fix typos Found via `typos --format brief` --- CHANGES | 10 +++++----- MIGRATION | 2 +- docs/_ext/aafig.py | 6 +++--- docs/_static/img/tmuxp.svg | 18 +++++++++--------- docs/about.md | 2 +- docs/cli/ls.md | 2 +- docs/conf.py | 2 +- docs/plugins/index.md | 2 +- tests/cli/test_shell.py | 10 +++++----- tests/fixtures/workspace/expand1.py | 4 ++-- tests/fixtures/workspace/sample_workspace.py | 2 +- .../fixtures/workspace/shell_command_before.py | 6 +++--- tests/fixtures/workspace/trickle.py | 4 ++-- tests/workspace/test_config.py | 4 ++-- tests/workspace/test_freezer.py | 4 ++-- 15 files changed, 39 insertions(+), 39 deletions(-) diff --git a/CHANGES b/CHANGES index 14c8b9a40b3..1cb015d1b1d 100644 --- a/CHANGES +++ b/CHANGES @@ -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]. @@ -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) @@ -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) @@ -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. diff --git a/MIGRATION b/MIGRATION index 0d31b4e3776..569d11a37c6 100644 --- a/MIGRATION +++ b/MIGRATION @@ -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. 🙏) diff --git a/docs/_ext/aafig.py b/docs/_ext/aafig.py index 91a37a66b62..2c5775043c0 100644 --- a/docs/_ext/aafig.py +++ b/docs/_ext/aafig.py @@ -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. @@ -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"): @@ -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) diff --git a/docs/_static/img/tmuxp.svg b/docs/_static/img/tmuxp.svg index 7ca72909e3d..12bf640f7f2 100644 --- a/docs/_static/img/tmuxp.svg +++ b/docs/_static/img/tmuxp.svg @@ -98,11 +98,11 @@ id="title2349">Bottom bar shadow object (Shape) Blue Sqaure Group object (Shape) + id="title966">Blue Square Group object (Shape) Yellow Sqaure Group object (Shape) + id="title962">Yellow Square Group object (Shape) Bottom bar object (Shape) Light Blue Sqaure Group object (Shape) + id="title964">Light Blue Square Group object (Shape) = 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`. diff --git a/docs/cli/ls.md b/docs/cli/ls.md index 1b0ba3b6437..4e5ec75fee3 100644 --- a/docs/cli/ls.md +++ b/docs/cli/ls.md @@ -4,7 +4,7 @@ # tmuxp ls -List sesssions. +List sessions. ```{eval-rst} .. argparse:: diff --git a/docs/conf.py b/docs/conf.py index 083e01c36a9..5bf2406606b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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 diff --git a/docs/plugins/index.md b/docs/plugins/index.md index a4a0129f9d9..a5c3a9f31ba 100644 --- a/docs/plugins/index.md +++ b/docs/plugins/index.md @@ -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 diff --git a/tests/cli/test_shell.py b/tests/cli/test_shell.py index 28241205921..8dafac33462 100644 --- a/tests/cli/test_shell.py +++ b/tests/cli/test_shell.py @@ -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}", ), diff --git a/tests/fixtures/workspace/expand1.py b/tests/fixtures/workspace/expand1.py index 97d4e3f253a..4cd6c401aad 100644 --- a/tests/fixtures/workspace/expand1.py +++ b/tests/fixtures/workspace/expand1.py @@ -11,7 +11,7 @@ {"shell_command": ["vim"]}, {"shell_command": 'cowsay "hey"'}, ], - "layout": "main-verticle", + "layout": "main-vertical", }, { "window_name": "logging", @@ -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", diff --git a/tests/fixtures/workspace/sample_workspace.py b/tests/fixtures/workspace/sample_workspace.py index 1db93f7ab43..baff8d4c924 100644 --- a/tests/fixtures/workspace/sample_workspace.py +++ b/tests/fixtures/workspace/sample_workspace.py @@ -8,7 +8,7 @@ {"start_directory": "~", "shell_command": ["vim"]}, {"shell_command": ['cowsay "hey"']}, ], - "layout": "main-verticle", + "layout": "main-vertical", }, { "window_name": "logging", diff --git a/tests/fixtures/workspace/shell_command_before.py b/tests/fixtures/workspace/shell_command_before.py index 6a7f0d6ab32..a952a3db543 100644 --- a/tests/fixtures/workspace/shell_command_before.py +++ b/tests/fixtures/workspace/shell_command_before.py @@ -16,7 +16,7 @@ "shell_command": ['cowsay "hey"'], }, ], - "layout": "main-verticle", + "layout": "main-vertical", }, { "shell_command_before": "rbenv local 2.0.0-p0", @@ -58,7 +58,7 @@ def config_expanded() -> Dict[str, Any]: "shell_command": [{"cmd": 'cowsay "hey"'}], }, ], - "layout": "main-verticle", + "layout": "main-vertical", }, { "shell_command_before": { @@ -119,7 +119,7 @@ def config_after() -> Dict[str, Any]: ], }, ], - "layout": "main-verticle", + "layout": "main-vertical", }, { "shell_command_before": { diff --git a/tests/fixtures/workspace/trickle.py b/tests/fixtures/workspace/trickle.py index d2c3d165fd7..662ebaf45b0 100644 --- a/tests/fixtures/workspace/trickle.py +++ b/tests/fixtures/workspace/trickle.py @@ -9,7 +9,7 @@ {"shell_command": [{"cmd": "vim"}]}, {"shell_command": [{"cmd": 'cowsay "hey"'}]}, ], - "layout": "main-verticle", + "layout": "main-vertical", }, { "window_name": "logging", @@ -33,7 +33,7 @@ {"shell_command": [{"cmd": "vim"}]}, {"shell_command": [{"cmd": 'cowsay "hey"'}]}, ], - "layout": "main-verticle", + "layout": "main-vertical", }, { "start_directory": "~", diff --git a/tests/workspace/test_config.py b/tests/workspace/test_config.py index 9fe380eba61..4bc142b9ecb 100644 --- a/tests/workspace/test_config.py +++ b/tests/workspace/test_config.py @@ -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", @@ -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", diff --git a/tests/workspace/test_freezer.py b/tests/workspace/test_freezer.py index 4848f1e3f11..b6179f2897b 100644 --- a/tests/workspace/test_freezer.py +++ b/tests/workspace/test_freezer.py @@ -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", @@ -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"]},