Improve documentation grammar, format, etc. #2158
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sambostock
commented
Aug 29, 2023
Comment on lines
83
to
90
| ## Delaying | ||
|
|
||
| There are situations when it is valuable to delay a job when it is being processed. | ||
| There are situations when it is useful to delay a job when it is being processed. | ||
|
|
||
| This can be handled using the `moveToDelayed` method. However, it is important to note that when a job is being processed by a worker, the worker keeps a lock on this job with a certain token value. For the `moveToDelayed` method to work, we need to pass said token so that it can unlock without error. Finally, we need to exit from the processor by throwing a special error `DelayedError` that will signal the worker that the job has been delayed so that it does not try to complete (or fail the job) instead. | ||
| This can be handled using the `moveToDelayed` method. However, it is important to note that when a job is being processed by a worker, the worker keeps a lock on this job with a certain token value. For the `moveToDelayed` method to work, we need to pass said token so that it can unlock without error. Finally, we need to exit from the processor by throwing a special error (`DelayedError`) that will signal to the worker that the job has been delayed so that it does not try to complete (or fail the job) instead. | ||
|
|
||
| ```typescript | ||
| import { DelayedError, Worker } from 'bullmq'; |
There was a problem hiding this comment.
I think this section needs to be audited by someone with more familiarity with moveToDelayed and DelayedError.
The code example uses moveToDelayed in one branch and throws DelayedError in the other branch, but this is different from the following example of moveToWaitingChildren and WaitingChildrenError, which are used in the same branch. Moreover, the description does not make it clear what the intended usage is.
This makes minor changes to the documentation, mostly consisting of small grammar and spelling fixes, as well as formatting, and some rewording.
sambostock
force-pushed
the
tweak-doc-wording
branch
from
3930ac5 to
f814d5b
Compare
sambostock
changed the title
rdmchr
reviewed
Nov 9, 2023
manast
approved these changes
Nov 18, 2023
| @@ -4,11 +4,11 @@ description: Processing jobs in batches | |||
|
|
|||
| # Batches | |||
|
|
|||
| It is possible to configure the workers so that instead of processing one job at a time they can process up to a number of jobs (a so-called batch) in one go. | |||
| It is possible to configure workers so that instead of processing one job at a time they can process up to a number of jobs (a so-called _batch_) in one go. | |||
There was a problem hiding this comment.
Are you sure "the" is not needed here? I am no native english speaker but it sounds wrong without the "the"
There was a problem hiding this comment.
Ok, chatGPT did indeed provide me with the answer :)
|
Thank you for this gigantic effort, very much appreciated! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This makes minor changes to the documentation, mostly consisting of small grammar and spelling fixes, as well as formatting, and some rewording.
I was reading through the documentation and noticed a few things, so I figured I'd fix them. I kept thinking I was close to the end of the documentation, so I might as well keep going... There was more than I thought, but I did skim through all of it.
Note that I am a new user of BullMQ, so I can not be sure if the content is actually correct (except in cases where it was obvious). This just aims to improve the language used.