-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOCSP-39849: revise job batching docs #2994
Conversation
docs/queues.txt
Outdated
'collection' => 'jobs', | ||
'queue' => 'default', | ||
'retry_after' => 60, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In #2985 (comment) we decided with @jmikola to comment optional settings.
'collection' => 'jobs', | |
'queue' => 'default', | |
'retry_after' => 60, | |
// 'collection' => 'jobs', | |
// 'queue' => 'default', | |
// 'retry_after' => 60, |
docs/queues.txt
Outdated
@@ -35,22 +38,29 @@ the driver in ``config/queue.php``: | |||
- Description | |||
|
|||
* - ``driver`` | |||
- **Required**. Specifies the queue driver to use. Must be ``mongodb``. | |||
- **Required**. Specifies the queue driver to use. The value of |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I find it cumbersome to repeat "Specifies" for every setting.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with minor comments!
docs/queues.txt
Outdated
// 'collection' => 'jobs', | ||
// 'queue' => 'default', | ||
// 'retry_after' => 60, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
S: It's a little unclear why these fields are commented out - are they optional? I think either leaving them uncommented and highlighting line 24 or deleting them altogether would be better
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Based on the table below, collection
and queue
are required so maybe leaving uncommented and highlighting line 24 is the way to go
https://jira.mongodb.org/browse/DOCSP-39849
Revises docs changes made in #2904
STAGING
Checklist