Merge pull request reduxjs#417 from erykpiast/patch-1

Add note about passing `ownProps` functions

Author: markerikson

docs/api.md

@@ -72,6 +72,26 @@ Instead, it *returns* a new, connected component class, for you to use.
   * [`pure = true`] *(Boolean)*: If true, implements `shouldComponentUpdate` and shallowly compares the result of `mergeProps`, preventing unnecessary updates, assuming that the component is a “pure” component and does not rely on any input or state other than its props and the selected Redux store’s state. *Defaults to `true`.*
   * [`withRef = false`] *(Boolean)*: If true, stores a ref to the wrapped component instance and makes it available via `getWrappedInstance()` method. *Defaults to `false`.*
 
+> Note: `ownProps` is passed to `mapStateToProps` and `mapDispatchToProps` only if formal definition of the function contains two mandatory parameters (function length has to be greater or equal 2). For example, functions defined like below won't receive `ownProps` as the second argument.
+```javascript
+function mapStateToProps() {
+  console.log(arguments[0]); // state
+  console.log(arguments[1]); // undefined
+}
+```
+```javascript
+const mapStateToProps = (...args) => {
+  console.log(arguments[0]); // state
+  console.log(arguments[1]); // undefined
+}
+```
+```javascript
+const mapStateToProps = (state, ownProps = {}) => {
+  console.log(state); // state
+  console.log(ownProps); // undefined
+}
+```
+
 #### Returns
 
 A React component class that injects state and action creators into your component according to the specified options.