Use 'deadlock' instead of 'blocking'#47866
Merged
Conversation
Contributor
Author
|
@dotnet/roslyn-ide I verified that the tool allows the use of the term 'hang' for the purpose stated above in documentation intended for technical audiences. I believe the use in a code comment clearly buckets this as "intended for technical audiences". |
Member
|
If we made this, do we need to make some changes for the policheck rules? Otherwise it might keep ask us to avoid the word 'hang' From the code itself, I guessing what 'hang' here mean is 'deadlock'? Is that precise enough to describe the scenario? |
sharwell
commented
Sep 23, 2020
'deadlock' is a more specific technical term in this context.
Cosifne
approved these changes
Sep 23, 2020
jasonmalinowski
approved these changes
Sep 24, 2020
jmarolf
approved these changes
Sep 24, 2020
Merged
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Builds on #47863 to use 'deadlock' instead of 'blocking'.
Blocking has a different meaning from the original text, and is not accurate in this context. This revert PR will allow us to find a more appropriate alternative, if necessary.
A 'hang' in a generic term for a deadlock, livelock, or UI delay long enough that it cannot be distinguished from the first two by a user. I am not aware of a recommended replacement term for this usage, so the term used for this meaning does not currently need to change. If it is changed, it should be changed either by clarifying the specific case that applies (i.e. one of these three conditions applies, but the others do not), or by using a more correct term (i.e. 'hang' was not the correct term in the first place).
On reviewing the comment in question for this change, 'hang' appears to be the term most readily understandable to a reader, but deadlock would likely suffice. I'm marking this change ready for review on the basis that 'hang' is arguably the current best term available for this comment.