diff options
author | Tim Gates <tim.gates@iress.com> | 2022-07-31 12:23:06 +1000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-07-31 09:23:06 +0700 |
commit | d82af1469f66ecfecd557aa7be1c00e419df0123 (patch) | |
tree | 14424c245836f294ba07ae7a7cbc4f6e7f34b60a | |
parent | 145884fcd5a016ee353da9ce1a586044bf058f45 (diff) | |
download | rq-d82af1469f66ecfecd557aa7be1c00e419df0123.tar.gz |
docs: Fix a few typos (#1679)
There are small typos in:
- docs/docs/exceptions.md
- docs/docs/jobs.md
- rq/queue.py
- tests/fixtures.py
- tests/test_job.py
Fixes:
- Should read `slightly` rather than `slighty`.
- Should read `requeuing` rather than `requeueing`.
- Should read `implementers` rather than `implementors`.
- Should read `definition` rather than `defition`.
- Should read `canceled` rather than `canceld`.
Signed-off-by: Tim Gates <tim.gates@iress.com>
-rw-r--r-- | docs/docs/exceptions.md | 2 | ||||
-rw-r--r-- | docs/docs/jobs.md | 6 | ||||
-rw-r--r-- | rq/queue.py | 2 | ||||
-rw-r--r-- | tests/fixtures.py | 2 | ||||
-rw-r--r-- | tests/test_job.py | 2 |
5 files changed, 7 insertions, 7 deletions
diff --git a/docs/docs/exceptions.md b/docs/docs/exceptions.md index c228d38..f757f2c 100644 --- a/docs/docs/exceptions.md +++ b/docs/docs/exceptions.md @@ -108,7 +108,7 @@ The handler can indicate this by returning a boolean. `False` means stop processing exceptions, `True` means continue and fall through to the next exception handler on the stack. -It's important to know for implementors that, by default, when the handler +It's important to know for implementers that, by default, when the handler doesn't have an explicit return value (thus `None`), this will be interpreted as `True` (i.e. continue with the next handler). diff --git a/docs/docs/jobs.md b/docs/docs/jobs.md index 54b993a..fd5bab3 100644 --- a/docs/docs/jobs.md +++ b/docs/docs/jobs.md @@ -319,7 +319,7 @@ job = queue.enqueue(foo_job, failure_ttl=300) # 5 minutes in seconds ``` -### Requeueing Failed Jobs +### Requeuing Failed Jobs If you need to manually requeue failed jobs, here's how to do it: @@ -342,9 +342,9 @@ Starting from version 1.5.0, RQ also allows you to [automatically retry failed jobs](https://python-rq.org/docs/exceptions/#retrying-failed-jobs). -### Requeueing Failed Jobs via CLI +### Requeuing Failed Jobs via CLI -RQ also provides a CLI tool that makes requeueing failed jobs easy. +RQ also provides a CLI tool that makes requeuing failed jobs easy. ```console # This will requeue foo_job_id and bar_job_id from myqueue's failed job registry diff --git a/rq/queue.py b/rq/queue.py index 167ad66..67c91a7 100644 --- a/rq/queue.py +++ b/rq/queue.py @@ -734,7 +734,7 @@ nd return job, queue return None, None - # Total ordering defition (the rest of the required Python methods are + # Total ordering definition (the rest of the required Python methods are # auto-generated by the @total_ordering decorator) def __eq__(self, other): # noqa if not isinstance(other, Queue): diff --git a/tests/fixtures.py b/tests/fixtures.py index 9895fed..9279a19 100644 --- a/tests/fixtures.py +++ b/tests/fixtures.py @@ -1,6 +1,6 @@ """ This file contains all jobs that are used in tests. Each of these test -fixtures has a slighty different characteristics. +fixtures has a slightly different characteristics. """ import os diff --git a/tests/test_job.py b/tests/test_job.py index bf7af5b..7dccda3 100644 --- a/tests/test_job.py +++ b/tests/test_job.py @@ -820,7 +820,7 @@ class TestJob(RQTestCase): self.assertNotIn(job, registry) def test_create_and_cancel_job_fails_already_canceled(self): - """Ensure job.cancel() fails on already canceld job""" + """Ensure job.cancel() fails on already canceled job""" queue = Queue(connection=self.testconn) job = queue.enqueue(fixtures.say_hello, job_id='fake_job_id') self.assertEqual(1, len(queue.get_jobs())) |