Editorial: Move a note at the end of a spec step #10814
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
|
hmm, I am not sure what I messed up with the branching. edit: Should be resolved now |
Instead of at the front of the next one, which was resulting in some slightly off rendering.
shannonbooth
force-pushed
the
reorder-note
branch
from
c07e9f8 to
c7b5589
Compare
domenic
reviewed
Dec 4, 2024
There was a problem hiding this comment.
I remember seeing this and it being awkward. However, I felt that since the note was talking about the state of the world before the step happened, it made sense to put it before the step.
I've suggested a compromise, which is to tweak the wording a bit in a way that hopefully avoids the confusion.
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.
Instead of at the front of the next one, which was resulting in some slightly strange looking rendering in: https://html.spec.whatwg.org/multipage/webappapis.html#resolve-a-module-specifier
Tried to follow the style guidelines as best as I can, as far as I can tell this looks like how notes are typically added. Though, it might make more sense if the note was instead moved to the end of that spec step instead of the bottom of the one proceeding it.
/webappapis.html ( diff )