Merge pull request #8 from letitia/model-collect-stores-docs

Model Collect Stores docs

Author: saponifi3d

Diff for: _collection-store/cache.md

@@ -3,5 +3,5 @@ header: cache
 example: CollectionStore.cache
 ---
 
-An object of collections to store data in memory to reduce the number of round trips to the API.  Overriding data or modifying the cache is not recommended, however it is helpful to inspect data.
+An object of collections that stores data in memory to reduce the number of round trips to the API.  Overriding data or modifying the cache is not recommended, but it is helpful for inspecting the data.
 

Diff for: _collection-store/clear.md

@@ -3,5 +3,5 @@ header: clear
 example: CollectionStore.clear([collectionName], [params])
 ---
 
-Clears the collection from the cache.  Passing both parameters will clear a specific collection, that matches the `collectionName` and `params`.  Passing only the `collectionName` will clear all instances of that collection. Passing no parameters will clear all collections from the store.
+Removes the collection from the cache.  Passing both parameters will clear a specific collection that matches the `collectionName` and `params`.  Passing only the `collectionName` will clear all instances of that collection.  Passing no parameters will clear all collections from the store.
 

Diff for: _collection-store/expireSeconds.md

@@ -3,4 +3,4 @@ header: expireSeconds
 example: CollectionStore.expireSeconds
 ---
 
-The time in seconds the collection will live in the store for.  By default this is set to `null`, so the data will not expire until a page reload.
+The length of time that the collection will be stored, in seconds.  By default this is set to `null`, so the data will not expire until the page is reloaded.

Diff for: _collection-store/get.md

@@ -3,17 +3,17 @@ header: get
 example: CollectionStore.get(collectionName, params, [callback])
 ---
 
-Returns the collection from the store based on the collection name and it's [params](/collection#params).
+Returns the collection from the store based on the collection name and its [params](/collection#params).
 
 You can also use the `get` function asynchronously by passing a `callback` function.
 
 ```js
 // async
-fetcher.collectionStore.get('users', {ids: [1,2,3]}, function (result) {
-  // can access the users in the result
+fetcher.collectionStore.get('UsersCollection', { ids: [1,2,3] }, function (result) {
+  // do something with the users
 });
 
 // sync
-var result = fetcher.collectionStore.get('users', { ids: [1,2,3] })
+var result = fetcher.collectionStore.get('UsersCollection', { ids: [1,2,3] })
 
 ```

Diff for: _collection-store/set.md

@@ -3,4 +3,4 @@ header: set
 example: CollectionStore.set(collection, params)
 ---
 
-Adds the collection to the [cache](#cache).  The params for the collection are required to use as part of a unique identifier for the collection.
+Adds the collection to the [cache](#cache).  The params for the collection are used as part of a unique identifier for the collection.

Diff for: _model-store/cache.md

@@ -3,5 +3,5 @@ header: cache
 example: ModelStore.cache
 ---
 
-An object of models to store data in memory to reduce the number of round trips to the API.  Overriding data or modifying the cache is not recommended, however it is helpful to inspect data.
+An object of models that stores data in memory to reduce the number of round trips to the API.  Overriding data or modifying the cache is not recommended, but it is helpful for inspecting the data.
 

Diff for: _model-store/clear.md

@@ -3,5 +3,5 @@ header: clear
 example: ModelStore.clear([modelName], [id])
 ---
 
-Removes the model(s) from the [cache](#cache).  If you pass both the `modelName` and the `id` it will clear that model from the store. If you only pass the `modelName` it will clear all of the models of that type in the store. Passing no arguments will clear the entire model store.
+Removes the model(s) from the [cache](#cache).  If you pass both the `modelName` and the `id` it will clear that model from the store.  If you only pass the `modelName` it will clear all of the models of that type in the store.  Passing no arguments will clear the entire model store.
 

Diff for: _model-store/expireSeconds.md

@@ -3,4 +3,4 @@ header: expireSeconds
 example: ModelStore.expireSeconds
 ---
 
-The time in seconds the model will live in the store for.  By default this is set to `null`, so the data will not expire until a page reload.
+The length of time that the model will be stored, in seconds.  By default this is set to `null`, so the data will not expire until the page is reloaded.

Diff for: _model-store/find.md

@@ -3,5 +3,8 @@ header: find
 example: ModelStore.find(modelName, attrs)
 ---
 
-Returns the first instance found that matches the `modelName` and `attrs` sent.  The `modelName` is the name of the model, the `attrs` is an object of attributes that the model is trying to find.
+Returns the first instance found that matches the `modelName` and `attrs` sent.  The `modelName` is the name of the model, the `attrs` is an object of parameters to search on.
 
+```js
+modelStore.find('Media', { type: "photo", id: 16 })
+```

Diff for: _model-store/get.md

@@ -3,4 +3,4 @@ header: get
 example: ModelStore.get(modelName, id)
 ---
 
-Returns the model from the store. Requires the name of the model and the model's `id`.
+Returns the model from the store.  Requires the name of the model and the model's `id`.

Diff for: _model-store/set.md

@@ -3,5 +3,5 @@ header: set
 example: ModelStore.set(model)
 ---
 
-Takes the `model` and adds it to the modelStore.  The function generates a key based on the model name and id, then inserts it into the cache.
+Adds the `model` to the model store.  This function generates a key based on the model name and id, then inserts it into the cache.
 

Diff for: collection-store/index.md

@@ -5,8 +5,8 @@ title: "Collection Store - RendrJS"
 
 # Collection Store
 
-The collection store is created to store collections in memory.  This will reduce the number of requests to the API by saving the results from the first API request.  The Collection Store also populates the [Model Store](/model-store), by adding each of the collection's models to it.  Generally, this does not need to be modified, and it is instantiated by the [app](/app) during the [app initialization](/app#constructor).
+The collection store is created to store collections in memory on the client-side.  This will reduce the number of requests to the API by saving the results from the first API request.  The Collection Store also populates the [Model Store](/model-store) by adding each of the collection's models to it.  Generally, this does not need to be modified, and it is instantiated by the [app](/app) during the [app initialization](/app#constructor).
 
-The Collection Store is attached to the [Fetcher](/fetcher) class.  This is so when you make a request through the fetcher, it will check the store before continuing the request.
+The Collection Store is attached to the [Fetcher](/fetcher) class, so when you make a request through the fetcher it will check the store before continuing the request.
 
 {% include pageDoc.html name="collection-store" %}

Diff for: model-store/index.md

@@ -5,8 +5,8 @@ title: "Model Store - RendrJS"
 
 # Model Store
 
-The Model Store is created to make a cache in memory, specifically for the client.  This will help reduce the number of client-side requests by checking to see if the data is in the store before making a fetch request.  Generally, this does not need to be modified, and it is instantiated by the [app](/app) during the [app initialization](/app#constructor).
+The Model Store is a cache in memory on the client.  This will help reduce the number of client-side requests by checking to see if the data is in the store before making a fetch request.  Generally, this does not need to be modified, and it is instantiated by the [app](/app) during the [app initialization](/app#constructor).
 
-The Model Store is attached to the [fetcher](/fetcher) class.  This allows the fetcher to easily get verify if data is in the store or not, before making the AJAX request to the API.
+The Model Store is attached to the [fetcher](/fetcher) class to allow the fetcher to easily verify whether data is in the store before making the AJAX request to the API.
 
 {% include pageDoc.html name="model-store" %}