Add explanatory text to examples. #460
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
|
PTAL @chrisn as you submitted the original issue. |
|
Thanks for the reminder, will do! |
chrisn
requested changes
Mar 27, 2019
|
Thanks for all the comments @chrisn, I applied them to the PR and merged. |
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.
This addresses Issue #435, by adding a brief explanation before each section of example code. It would be helpful for a second pair of eyes to point out anything that is still not obvious and could be improved.
It also addresses some ReSpec errors that have crept in, apparently because event names are not defined in WebIDL, and also conflict with function definitions. We'll just leave them unlinked for simplicity.
Preview | Diff