doc: improve ALS.enterWith and exit descriptions #36705
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
puzpuzpuz
added
doc
puzpuzpuz
force-pushed
the
enhancement/improve-als-exit-doc
branch
from
e412c20
to
830db9d
Compare
jasnell
approved these changes
Dec 31, 2020
Flarna
reviewed
Jan 1, 2021
Flarna
approved these changes
Jan 1, 2021
github-actions
bot
removed
the
request-ci
Trott
approved these changes
Jan 2, 2021
PR-URL: nodejs#36705 Refs: nodejs#36683 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gerhard Stöbich <[email protected]> Reviewed-By: Rich Trott <[email protected]>
Trott
force-pushed
the
enhancement/improve-als-exit-doc
branch
from
dfd594a
to
1b68030
Compare
|
Landed in 1b68030 |
danielleadams
pushed a commit
that referenced
this pull request
Jan 12, 2021
PR-URL: #36705 Refs: #36683 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gerhard Stöbich <[email protected]> Reviewed-By: Rich Trott <[email protected]>
Merged
targos
pushed a commit
that referenced
this pull request
May 1, 2021
PR-URL: #36705 Refs: #36683 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Gerhard Stöbich <[email protected]> Reviewed-By: Rich Trott <[email protected]>
Merged
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.
Refs: #36683
Aims to add more clarity into ALS'
enterWithandexitmethod docs in order to avoid confusion around their behavior.Also includes the following:
als.enterWith()mentioning in parallel withals.run()where necessary (e.g. inals.disable()'s doc)als.enterWith()'s in a way which is more consistent with other methods' docsChecklist
make -j4 test(UNIX), orvcbuild test(Windows) passes