NF: document that withCol and withQueue executes in IO
#13950
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
dae
reviewed
Jun 4, 2023
| @@ -58,8 +58,8 @@ object CollectionManager { | |||
| var emulateOpenFailure = false | |||
|
|
|||
| /** | |||
| * Execute the provided block on a serial queue, to ensure concurrent access | |||
| * does not happen. | |||
| * Execute the provided block in the IO dispatchers on a serial queue. | |||
There was a problem hiding this comment.
Suggested change
| * Execute the provided block in the IO dispatchers on a serial queue. | |
| * Execute the provided block on a serial background queue, to ensure concurrent access | |
| does not happen. | |
| * The background queue is run in a Dispatchers.IO context. |
There was a problem hiding this comment.
Involving Dispatchers.IO in brackets will make it clickable, i.e. [Dispatchers.IO]
dae
reviewed
Jun 4, 2023
dae
reviewed
Jun 4, 2023
| @@ -88,6 +88,8 @@ object CollectionManager { | |||
| /** | |||
| * Execute the provided block with the collection, opening if necessary. | |||
| * | |||
| * Execution is done in the IO dispatchers. | |||
There was a problem hiding this comment.
Suggested change
| * Execution is done in the IO dispatchers. | |
| * Calls are serialized, and run in background Dispatchers.IO thread. |
There was a problem hiding this comment.
Sorry Arthur, I had a typo here: it should have read "run in a". Might as well add another [] at the same time.
dae
reviewed
Jun 4, 2023
BrayanDSO
added
the
Needs Author Reply
I had some doubt about which function moves to IO dispatcher, whether it was launch method or withCol. I expect this documentation may save a minute to other devs too.
Arthur-Milchior
force-pushed
the
documentIO
branch
from
fc8a31e
to
57889a9
Compare
|
I'm all for bikeshedding here, given that my goal was to improve documentation of a part of the code that seems to be non intuitive. (Or at least, was not to me at first) |
Arthur-Milchior
removed
the
Needs Author Reply
BrayanDSO
reviewed
Jun 9, 2023
BrayanDSO
added
Pending Merge
BrayanDSO
approved these changes
Jun 9, 2023
github-actions
bot
removed
Pending Merge
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.
I had some doubt about which function moves to IO dispatcher, whether it was launch method or withCol. I expect this documentation may save a minute to other devs too.