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>
main
Tim Gates 2 years ago committed by GitHub
parent 145884fcd5
commit d82af1469f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -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 processing exceptions, `True` means continue and fall through to the next
exception handler on the stack. 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 doesn't have an explicit return value (thus `None`), this will be interpreted
as `True` (i.e. continue with the next handler). as `True` (i.e. continue with the next handler).

@ -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: 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). 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 ```console
# This will requeue foo_job_id and bar_job_id from myqueue's failed job registry # This will requeue foo_job_id and bar_job_id from myqueue's failed job registry

@ -734,7 +734,7 @@ nd
return job, queue return job, queue
return None, None 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) # auto-generated by the @total_ordering decorator)
def __eq__(self, other): # noqa def __eq__(self, other): # noqa
if not isinstance(other, Queue): if not isinstance(other, Queue):

@ -1,6 +1,6 @@
""" """
This file contains all jobs that are used in tests. Each of these test 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 import os

@ -820,7 +820,7 @@ class TestJob(RQTestCase):
self.assertNotIn(job, registry) self.assertNotIn(job, registry)
def test_create_and_cancel_job_fails_already_canceled(self): 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) queue = Queue(connection=self.testconn)
job = queue.enqueue(fixtures.say_hello, job_id='fake_job_id') job = queue.enqueue(fixtures.say_hello, job_id='fake_job_id')
self.assertEqual(1, len(queue.get_jobs())) self.assertEqual(1, len(queue.get_jobs()))

Loading…
Cancel
Save