From 243a72603ab118d29ae53a176650430afe32dea8 Mon Sep 17 00:00:00 2001
From: Ajay NS <Ajay.ns@outlook.com>
Date: Thu, 15 Feb 2018 06:50:13 +0530
Subject: [PATCH] Add documentation for using boundActionCreators fixes #4029
 (#4042)

* Add documentation for using boundActionCreators

* Update bound-action-creators.js

* Fix
---
 www/src/pages/docs/bound-action-creators.js | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/www/src/pages/docs/bound-action-creators.js b/www/src/pages/docs/bound-action-creators.js
index b54ecda08661c..693c3a87fe1d6 100644
--- a/www/src/pages/docs/bound-action-creators.js
+++ b/www/src/pages/docs/bound-action-creators.js
@@ -25,6 +25,24 @@ class ActionCreatorsDocs extends React.Component {
           and dispatch Redux actions when called) which you can use to
           manipulate state on your site.
         </p>
+        <p>
+          The object
+          {` `}
+          <code>boundActionCreators</code>
+          {` `}
+          contains the functions and these can be individually extracted by
+          using ES6 object destructuring.
+        </p>
+        <pre
+          dangerouslySetInnerHTML={{
+            __html: `
+<code class=" language-javascript"><span class="token comment">// For function createNodeField</span>
+exports<span class="token punctuation">.</span><span class="token function-variable function">onCreateNode</span> <span class="token operator">=</span> <span class="token punctuation">(</span><span class="token punctuation">{</span> node<span class="token punctuation">,</span> getNode<span class="token punctuation">,</span> boundActionCreators <span class="token punctuation">}</span><span class="token punctuation">)</span> <span class="token operator">=&gt;</span> <span class="token punctuation">{</span>
+  <span class="token keyword">const</span> <span class="token punctuation">{</span> createNodeField <span class="token punctuation">}</span> <span class="token operator">=</span> boundActionCreators
+<span class="token punctuation">}</span></code>
+  `,
+          }}
+        />
         <h2 css={{ marginBottom: rhythm(1 / 2) }}>Functions</h2>
         <ul css={{ ...scale(-1 / 5) }}>
           {this.props.data.allDocumentationJs.edges.map(({ node }, i) => (