docs

datalytica · Jun 26, 2017 · 7d78e82 · 7d78e82
1 parent ecb1594
commit 7d78e82
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 3 deletions.
diff --git a/packages/datastore/src/action.ts b/packages/datastore/src/action.ts
@@ -8,10 +8,10 @@
 
 
 /**
- * An object which represents an action.
+ * An object which represents an action for a data store.
  *
  * #### Notes
- * Custom actions may implement this interface.
+ * Actions are dispatched to a data store to change its state.
  */
 export
 interface IAction {

diff --git a/packages/datastore/src/datastore.ts b/packages/datastore/src/datastore.ts
@@ -19,7 +19,7 @@ import {
 
 
 /**
- * A lightweight data store which largely follows the redux pattern.
+ * A lightweight data store which mostly follows the redux pattern.
  *
  * #### Notes
  * The `S` type parameter is an interface defining the state shape.

diff --git a/packages/datastore/src/reducer.ts b/packages/datastore/src/reducer.ts
@@ -18,6 +18,9 @@ import {
  * @param action - The action to perform on the state.
  *
  * @returns The new state for the application.
+ *
+ * #### Notes
+ * A reducer processes actions to update the data store state.
  */
 export
 type Reducer<S, A extends IAction> = (state: S, action: A) => S;