Editorial: clarify adoption agency step 13.3 #9785
Closed
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
After implementing the adoption agency algorithm as described in the specification, I was very confused why some respective tests of html5lib-tests were failing. As it turns out I misinterpreted: > If node is formatting element, then break. as "if node is a formatting element" (i.e. any element in the formatting category). I missed that "formatting element" referred to the "formatting element" variable. Indeed, the source file does declare it with the <var> tag, however in the rendered spec this just becomes italic text, which evidently is easy to miss. This commit therefore clarifies the wording to: > If node is the formatting element, then break.
|
It is not correct to use "the" when referring to variables in spec language, so this change is not correct. One potential fix here is to move the algorithm toward using modern style camelCase variables. However, I wouldn't want to do this for only a single variable. Are you up for a PR that updates all the variables in the adoption agency to that modern style? |
|
For sure ... that makes sense :) Closing in favor of #9786. |
Sidenote: is the "spec language" documented somewhere? i.e. is there a style guide? |
|
There's a very high-level one: https://whatwg.org/style-guide. We also specify a bunch of the modern rules in https://infra.spec.whatwg.org. |
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.
After implementing the adoption agency algorithm as described in the specification, I was very confused why some respective tests of html5lib-tests were failing. As it turns out I misinterpreted:
as "if node is a formatting element" (i.e. any element in the formatting category). I missed that "formatting element" referred to the "formatting element" variable. Indeed, the source file does declare it with the tag, however in the rendered spec this just becomes italic text, which evidently is easy to miss.
This commit therefore clarifies the wording to:
/parsing.html ( diff )