Editorial: Use Bikeshed's algorithm and var more better #336
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
|
@domenic - no good deed goes unpunished - can you take a look? Thanks! |
domenic
approved these changes
May 20, 2020
There was a problem hiding this comment.
This seems pretty good, but personally I prefer avoiding using <var ignore> for "named parameter passing", instead just using positional parameters.
I'd especially suggest avoiding mixing named and positional parameters; I identified one spot where this is done. Otherwise, many of the named parameter passing sites are done when you need to pass an operation. Those could probably be clearer if they were refactored into two steps, one to create the operation as an independent variable, and another to call the operation-accepting algorithm.
|
One more look, @domenic? |
inexorabletash
added a commit
that referenced
this pull request
Feb 1, 2021
Switch from <div class=algorithm> to <div algorithm> to get better var highlighting/checking. A consequence of this is fixing issues, the biggest one being places where algorithm A calls into B with named parameters, e.g. "with foo as bar". In that case, "bar" needs to be called out with <var ignore>. Named arguments removed in favor of positional arguments everywhere. Also, the convoluted phrasing around passing an operation to "asynchronously execute..." was simplified by making the operation assembly into an anonymous algorithm a separate step. A few other glitches were noticed along the way, e.g. in domintro sections, some non-normative text was correctly marked as asides, and a few incorrect variables were fixed. Big thanks to @domenic for his suggestions and guidance here.
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.
The following tasks have been completed:
Switch from
<div class=algorithm>to<div algorithm>to get better var highlighting/checking. A consequence of this is fixing issues, the biggest one being places where algorithm A calls into B with named parameters, e.g. "with foo as bar". In that case, "bar" needs to be called out with<var ignore>.A few other glitches were noticed along the way, e.g. in domintro sections, some non-normative text was correctly marked as asides, and a few incorrect variables were fixed.
Preview | Diff