Readme v2 0 #83
Merged
Readme v2 0 #83
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
Reformat image alignment. Removed "Known Issues" as it forms the incorrect thinking that stampit has problems. Moreover, if someone would need to browse issues he most likely knows what menu item to click on the right. :)
Rename the rest of 'state' and 'enclose' to 'refs' and 'init'.
Added v2 breaking changes description.
added "what is a stamp?" section
Removed `settings` parameter from `init()` function. There is no such thing AFAIK. :)
8 tasks
| var b = stampit().enclose(function () { | ||
| var a = 'b'; | ||
| var b = stampit().init(function () { | ||
| var priv = 'b'; | ||
| this.getB = function () { | ||
| return a; |
There was a problem hiding this comment.
Is this correct? shouldn't it be return priv ?
There was a problem hiding this comment.
👍 Spot on! Let me correct that.
Fixing typo in a sample code.
|
|
||
| Stampit mimics the behavior of `_.extend()`, `$.extend()` when you pass multiple objects into one of the prototype methods. In other words, it will copy all of the properties from those objects to the `.methods`, `.state`, or `.enclose` prototype for the stamp. The properties from later arguments in the list will override the same named properties of previously passed in objects. | ||
| Stampit mimics the behavior of `_.extend()`, `$.extend()` when you pass multiple objects into one of the prototype methods. | ||
| In other words, it will copy all of the properties from those objects to the `.methods`, `.refs`, or `.init` prototype for the stamp. |
There was a problem hiding this comment.
Mention .props here and remind the user that it will merge?
Mention `.props()` more. Fix mistakes of all sorts.
|
|
||
| [Known Issues](https://github.com/dilvie/stampit/issues?state=open) | ||
| There is a slight chance these changes affect your current codebase. If so, we would recommend you to update to v2 becuase it is more powerful. See [advances examples](https://github.com/ericelliott/stampit/blob/master/EXAMPLES.md). |
There was a problem hiding this comment.
You mean "advanced examples"?
Minor updates to multiple places.
Describing new `stampit(options)` API. Fix examples. Do not use word "prototype" as too confusing in JS world. Use "stamp" instead. Plenty minor changes.
|
Ready to be merged to v2_0 I think. Check the latest changes please. |
|
|
||
| Take n objects and add them to the state prototype. Changes `this` object. | ||
| * @return {Object} stamp The stamp in question (`this`). | ||
| It has alias - `stamp.state()`. Deprecated. |
typos
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.
@ericelliott, please review.
The bullet list of changes can be found in #71.