Skip to content

Commit

Permalink
Improve documentation for createParentChildLink (gatsbyjs#3594)
Browse files Browse the repository at this point in the history
* Improve documentation for createParentChildLink

* Format

* edit
  • Loading branch information
KyleAMathews authored and jastack committed Jan 24, 2018
1 parent 3390a5f commit a9d9c4f
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion packages/gatsby/src/redux/actions.js
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit a9d9c4f

Please sign in to comment.