From 497ec7c7e33eed6f271edf15f78d112f42add39d Mon Sep 17 00:00:00 2001 From: Tim Gates Date: Fri, 15 Jul 2022 08:53:52 +1000 Subject: [PATCH] docs: Fix a few typos There are small typos in: - README.rst - docs/conf.py - salmon/commands.py - salmon/routing.py - tests/test_integration.py - tests/test_server.py Fixes: - Should read `under` rather than `uner`. - Should read `that` rather than `shat`. - Should read `only` rather than `onlly`. - Should read `module` rather than `modiule`. - Should read `destroyed` rather than `destoryed`. - Should read `configuration` rather than `configureation`. - Should read `affected` rather than `afffected`. Signed-off-by: Tim Gates --- README.rst | 2 +- docs/conf.py | 2 +- salmon/commands.py | 4 ++-- salmon/routing.py | 2 +- tests/test_integration.py | 2 +- tests/test_server.py | 2 +- 6 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 00e6fde..1226d73 100644 --- a/README.rst +++ b/README.rst @@ -16,7 +16,7 @@ Apache or Nginx. It has all the features of a web application stack (templates, routing, handlers, state machine) and plays well with other libraries, such as Django and SQLAlchemy. -Salmon has been released uner the GNU GPLv3, as published by the FSF. +Salmon has been released under the GNU GPLv3, as published by the FSF. Features ======== diff --git a/docs/conf.py b/docs/conf.py index 5a2b3e6..a4451ec 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -344,7 +344,7 @@ # The format is a list of tuples containing the path and title. #epub_pre_files = [] -# HTML files shat should be inserted after the pages created by sphinx. +# HTML files that should be inserted after the pages created by sphinx. # The format is a list of tuples containing the path and title. #epub_post_files = [] diff --git a/salmon/commands.py b/salmon/commands.py index 9566891..42ddad0 100644 --- a/salmon/commands.py +++ b/salmon/commands.py @@ -18,7 +18,7 @@ import salmon # squash warning about unicode literals. if there are bugs here, then it's -# quite likely to have afffected us before switching to click. +# quite likely to have affected us before switching to click. click.disable_unicode_literals_warning = True DEFAULT_PID_FILE = "./run/smtp.pid" @@ -266,7 +266,7 @@ def routes(modules, test, path): messages not getting to your handlers. Path has the search paths you want separated by a ':' character, and it's added to the sys.path. - MODULE should be a configureation module and can be given multiple times. + MODULE should be a configuration module and can be given multiple times. """ _import_router_modules(modules, path) test_case_matches = [] diff --git a/salmon/routing.py b/salmon/routing.py index 5be58ca..c0370e7 100644 --- a/salmon/routing.py +++ b/salmon/routing.py @@ -12,7 +12,7 @@ The salmon.routing.StateStorage is what you need to implement if you want Salmon to store the state in a different way. By default the salmon.routing.Router object just uses a default MemoryStorage to do its job. -If you want to use a custom storage, then in your boot modiule you would set +If you want to use a custom storage, then in your boot module you would set salmon.routing.Router.STATE_STORE to what you want to use. Finally, when you write a state handler, it has functions that act as state diff --git a/tests/test_integration.py b/tests/test_integration.py index 97ea22f..9a9b47e 100644 --- a/tests/test_integration.py +++ b/tests/test_integration.py @@ -41,7 +41,7 @@ def tearDownClass(cls): def setUp(self): super().setUp() - # re-create destoryed queues + # re-create destroyed queues queue.Queue(os.path.join(self._cwd, server_settings.UNDELIVERABLE_QUEUE)).clear() queue.Queue(os.path.join(self._cwd, server_settings.QUEUE_PATH)).clear() diff --git a/tests/test_server.py b/tests/test_server.py index 010dd29..e6b57e8 100644 --- a/tests/test_server.py +++ b/tests/test_server.py @@ -318,7 +318,7 @@ def test_queue_receiver_pool(self, pool_mock): args = receiver.workers.apply_async.call_args[1]["args"] del receiver.workers.apply_async.call_args[1]["args"] - # onlly the "args" kwarg should be present + # only the "args" kwarg should be present self.assertEqual(receiver.workers.apply_async.call_args[1], {}) # we can't compare two Mail* objects, so we'll just check the type