Fix minor typos in enqueue_after_transaction_commit default docs
#51526
Conversation
This file contains hidden or 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
joshuay03
commented
Apr 9, 2024
| @@ -28,8 +28,8 @@ | |||
| # If `enqueue_after_transaction_commit` is set to `:default`, the queue adapter | |||
| # will define the behaviour. | |||
| # | |||
| # Note: Active Job backends can disable this feature. This is generally used by | |||
There was a problem hiding this comment.
I found this slightly confusing to read. used implies that we're referring to (enabling) the feature, but we're actually referring to the action of disabling it.
joshuay03
commented
Apr 9, 2024
| # Note: Active Job backends can disable this feature. This is generally used by | ||
| # backends that use the same database than Active Record as a queue, hence they | ||
| # Note: Active Job backends can disable this feature. This is generally done by | ||
| # backends that use the same database as Active Record as a queue, hence they |
There was a problem hiding this comment.
This also makes this note consistent with a similar section in guides/source/configuring.md that was updated in #51489.
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.
Motivation / Background
Just a minor doc improvement I thought could be made when reading through the implementation for this feature.
Detail
Updates a note in
railties/lib/rails/generators/rails/app/templates/config/initializers/new_framework_defaults_7_2.rb.ttaboutenqueue_after_transaction_committo improve clarity.Additional information
None.
Checklist
Before submitting the PR make sure the following are checked:
[Fix #issue-number]