From 7cb16ba7d5dd1fcb105fec81a5c5bf897b57317b Mon Sep 17 00:00:00 2001 From: Kyle Mathews Date: Thu, 18 Jan 2018 16:32:30 -0800 Subject: [PATCH] Improve documentation for createParentChildLink (#3594) * Improve documentation for createParentChildLink * Format * edit --- packages/gatsby/src/redux/actions.js | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/packages/gatsby/src/redux/actions.js b/packages/gatsby/src/redux/actions.js index 756e84a6aef22..73ca9f692c961 100644 --- a/packages/gatsby/src/redux/actions.js +++ b/packages/gatsby/src/redux/actions.js @@ -544,7 +544,11 @@ actions.createNodeField = ( } /** - * Creates a link between a parent and child node + * Creates a link between a parent and child node. This is used when you + * transform content from a node creating a new child node. You need to add + * this new child node to the `children` array of the parent but since you + * don't have direct access to the immutable parent node, use this action + * instead. * @param {Object} $0 * @param {Object} $0.parent the parent node object * @param {Object} $0.child the child node object