Editorial: Add brief explanations to examples #232
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
|
@sisidovski @tunetheweb wdyt? |
sisidovski
approved these changes
Aug 29, 2024
spec.bs
Outdated
|
|
||
| This is a more complicated pattern which includes: | ||
| * [=part/modifier/optional=] parts marked with `?` (braces are needed to make it unambiguous exactly what is optional), and | ||
| * a [=part/type/regexp=] part named "`id`" which uses a regular expression to define what sorts of substrings match (the parentheses are required to mark it as a regular expression, and are not part of the regexp itself) |
There was a problem hiding this comment.
We may want a dot . at the end of the paragraph?
There was a problem hiding this comment.
It's a pretty fine point of style (punctuating bulleted lists is complicated), but on average the search results I found agree that there should be a period here, so done.
|
IMO adding an explicit explanation paragraph how to create a custom regexp group in 2. Pattern strings makes sense. WDYT? |
Added the text "enclosed in parentheses" to that section. |
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.
These examples form the only quick reference material in the spec. While MDN goes into more depth, brief explanations of what is happening in this syntax don't take up much room and may make it easier to tell what's going on, especially with regexp parts.
Resolves #229.
Preview | Diff