Skip to content

Commit 490d902

Browse files
docs: fix several grammar errors in docs (#3011)
1 parent 71733cc commit 490d902

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

docs/gitbook/guide/jobs/deduplication.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Deduplication in BullMQ is a process where job execution is delayed and deduplic
44

55
## Simple Mode
66

7-
The Simple Mode takes a different approach by extending the deduplication duration until the job's completion or failure. This means as long as the job remains in an incomplete state (neither succeeded nor failed), any subsequent job with the same deduplication ID will be ignored.
7+
The Simple Mode extends the deduplication duration until the job's completion or failure. This means that as long as the job remains in an incomplete state (neither succeeded nor failed), any subsequent job with the same deduplication ID will be ignored.
88

99
```typescript
1010
// Add a job that will be deduplicated as this record is not finished (completed or failed).
@@ -46,15 +46,15 @@ Any manual deletion will disable the deduplication. For example, when calling _j
4646

4747
## Get Deduplication Job Id
4848

49-
If you need to know which is the job id that started the deduplicated state. You can call **getDeduplicationJobId** method.
49+
If you need to know the id of the job that started the deduplicated state, you can call the **getDeduplicationJobId** method.
5050

5151
```typescript
5252
const jobId = await myQueue.getDeduplicationJobId('customValue');
5353
```
5454

5555
## Remove Deduplication Key
5656

57-
If you need to stop deduplication before ttl finishes or before finishing a job. You can call **removeDeduplicationKey** method.
57+
If you need to stop deduplication before ttl finishes or before finishing a job, you can call the **removeDeduplicationKey** method.
5858

5959
```typescript
6060
await myQueue.removeDeduplicationKey('customValue');

docs/gitbook/guide/jobs/job-ids.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ await myQueue.add(
2727
```
2828

2929
{% hint style="danger" %}
30-
Custom job ids must not contains **:** separator as it will be translated in 2 different values, we are also following Redis naming convention. So if you need to add a separator, use a different value, for example **-**, **\_**.
30+
Custom job ids must not contain the **:** separator as it will be translated in 2 different values, since we are also following Redis naming convention. So if you need to add a separator, use a different value, for example **-**, **\_**.
3131
{% endhint %}
3232

3333
## Read more:

docs/gitbook/guide/queues/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,8 @@ Prior to BullMQ 2.0, in order for delay jobs to work you need to have at least o
3636
From BullMQ 2.0 and onwards, the `QueueScheduler` is not needed anymore.
3737
{% endhint %}
3838

39-
There are many other options available such as priorities, backoff settings, lifo behaviour, remove-on-complete policies, etc. Please check the remaining of this guide for more information regarding these options.
39+
There are many other options available such as priorities, backoff settings, lifo behaviour, remove-on-complete policies, etc. Please check the remainder of this guide for more information regarding these options.
4040

4141
## Read more:
4242

43-
* 💡 [Queue API Reference](https://api.docs.bullmq.io/classes/v5.Queue.html)
43+
- 💡 [Queue API Reference](https://api.docs.bullmq.io/classes/v5.Queue.html)

docs/gitbook/guide/queuescheduler.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ await queueScheduler.close();
1818
This class automatically moves delayed jobs back to the waiting queue when it is the right time to process them. It also automatically checks for stalled jobs (i.e. detects jobs that are active but where the worker has either crashed or stopped working properly). [Stalled jobs](jobs/stalled.md) are moved back or failed depending on the settings selected when instantiating the class.
1919

2020
{% hint style="info" %}
21-
You need at least one `QueueScheduler` running somewhere for a given queue if you require functionality such as delayed jobs, retries with backoff and rate limiting.
21+
You need at least one `QueueScheduler` running somewhere for a given queue if you require functionality such as delayed jobs, retries with backoff, and rate limiting.
2222
{% endhint %}
2323

2424
The reason for having this functionality in a separate class instead of in the workers (as in Bull 3.x) is because whereas you may want to have a large number of workers for parallel processing, for the scheduler you probably only want a couple of instances for each queue that requires delayed or stalled checks. One will be enough but you can have more just for redundancy.
@@ -29,4 +29,4 @@ It is ok to have as many `QueueScheduler` instances as you want, just keep in mi
2929

3030
## Read more:
3131

32-
* 💡 [Queue Scheduler API Reference](https://api.docs.bullmq.io/classes/v1.QueueScheduler.html)
32+
- 💡 [Queue Scheduler API Reference](https://api.docs.bullmq.io/classes/v1.QueueScheduler.html)

0 commit comments

Comments
 (0)