Updated Read Me & Documentation in the code. #16
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
This is so we can get code-completion & basic type checking in environments that don't use the typescript definitions file.
Added notes about where/when decorators work in Babel 5.x Also added info on how to enable decorators in 5.x (lots of people still use 5.x due to JSPM still using it)
Rationale: It's nice to be able to copy the quick start into a file, and just run it and see a result.
This is so we can get code-completion & basic type checking in environments that don't use the typescript definitions file.
Added notes about where/when decorators work in Babel 5.x Also added info on how to enable decorators in 5.x (lots of people still use 5.x due to JSPM still using it)
Rationale: It's nice to be able to copy the quick start into a file, and just run it and see a result.
Applying patches from vonovak @ mobxjs#15 Added changes to the documentation within code
{*} is render as Any in the documentation, and now JSdoc inferences
work normally with editors that use them.
The top section of typedefs wasn't being picked up by IntelliJ because
of the formatting.
Property names in the documentation now match their real name in the
code.
Closed
|
This is awesome, thans a lot! (and sorry for the late follow up!) |
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.
My general aim was to make all the code examples in the README file into valid javascript.
I also wanted to make the longer form code examples that weren't part of document-gem (e.g. the quick start and the putting it all together), into something that could be executed directly w/o having to write any additional code. I tried my best to keep the 'spirit' of the code but if i erred in that, please tell me.
Additionally:
Hope this helps. If you only want to use some of this, I can parcel that into a digestible chunk.