Improve description of cmderr "busy" #1076
Open
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
- Improve the wording of what happens if another abstract command is started while the previous one still executes. Make the order of events very clear. - Unify the wording of cmderr "busy" requirement for all concerned DM registers. Make it clearer to the reader that the prescribed behavior is the same in all the cases.
|
See #1072 for the related discussion. |
stefano-codasip
approved these changes
Oct 9, 2024
There was a problem hiding this comment.
Changes are in line with ticket #1072 comments and aligned to expectations after discussing with Jan.
en-sc
reviewed
Oct 9, 2024
rtwfroody
reviewed
Feb 17, 2025
Comment on lines
-336
to
+334
| unavailable, or because they encounter an error during execution. | ||
| unavailable, because they encounter an error during execution. |
There was a problem hiding this comment.
I think you do need "or" here.
Comment on lines
-680
to
+681
| {abstractcs-cmderr} to be set to 1 (busy) if it is 0. | ||
| {abstractcs-cmderr} to become 1 (busy) once the command completes | ||
| (once {abstractcs-busy} becomes 0). |
There was a problem hiding this comment.
I'm on the fence about "become 1" while "becomes 0" reads OK to me. Not sure why but I wanted to point it out. Thoughts?
Comment on lines
+336
to
+339
| If the debugger attempts to start a new command while {abstractcs-busy} is set, | ||
| the new command will not get started and the currently executing command still | ||
| gets to run to completion. After that, {abstractcs-cmderr} becomes 1 (busy), | ||
| and any error generated by the completed command is lost. |
There was a problem hiding this comment.
So the meat of this change is to move this into its own paragraph so that it's more obvious to a reader that this is the behavior no matter how an abstract command is started? (Can you start one without writing to dm.command?) Did I get that right?
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.
Improve the wording of what happens if another abstract command is started while the previous one still executes. Make the order of events very clear.
Unify the wording of cmderr "busy" requirement for all concerned DM registers. Make it clearer to the reader that the prescribed behavior is the same in all the cases.