Improve documentation #57
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
| import injectService from 'ember-service/inject'; | ||
| ``` | ||
|
|
||
| Where the shim exports an object namespace, use ES6 [destructuring assignment](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment) |
There was a problem hiding this comment.
This isn't destructuring, it is importing a named export (destructuring assignment involves an assignment).
Spec here: http://www.ecma-international.org/ecma-262/6.0/#sec-destructuring-assignment.
There was a problem hiding this comment.
Yup, thanks! Brain conflating a lot of things today. :(
|
I left a nit-pick, but otherwise this looks good. Can you include some verbiage that indicates that the goal of this particular library is to be replaced once ember itself is an NPM package / addon? |
The goal of this change is three-fold: - Demonstrate how to utilize the module imports - Link to the shims file as a reference of all supported shims (documenting them in the README would be too verbose and mostly a copy/paste from the code itself) - Explain why developers might want to use the shims over other common patterns
|
@rwjblue updated, thanks for the feedback! |
|
LGTM |
|
Thank you! |
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.
Rendered
The goal of this change is three-fold: