From 8c162347e94d401b04e523a8ef301c669cb443e1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Sat, 28 Apr 2018 17:37:46 +0200 Subject: [PATCH 1/2] Fix replaceHydrateFunction doc --- packages/gatsby/src/utils/api-browser-docs.js | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/packages/gatsby/src/utils/api-browser-docs.js b/packages/gatsby/src/utils/api-browser-docs.js index 1e5cb2cd414c5..4b26619e579c8 100644 --- a/packages/gatsby/src/utils/api-browser-docs.js +++ b/packages/gatsby/src/utils/api-browser-docs.js @@ -75,10 +75,14 @@ exports.wrapRootComponent = true /** * Allow a plugin to replace the ReactDOM.render function call by a custom renderer. - * This method receives the same parameters as ReactDOM.render takes. - * Note it's very important to call the provided callback after rendering, otherwise Gatsby will not be able to call `onInitialClientRender` - * @param {object} $0 element - * @param {object} $1 container - * @param {object} $2 callback + * This method takes no param and should return a function with same signature as ReactDOM.render() + * Note it's very important to call the callback after rendering, otherwise Gatsby will not be able to call `onInitialClientRender` + * @example + * exports.replaceHydrateFunction = () => { + * return (element, container, callback) => { + * console.log("rendering!"); + * ReactDOM.render(element,container,callback); + * }; + * }; */ exports.replaceHydrateFunction = true From c7b85c878a31fb669a05e2c70122b241170780e3 Mon Sep 17 00:00:00 2001 From: Kyle Mathews Date: Sat, 28 Apr 2018 09:58:56 -0600 Subject: [PATCH 2/2] Add spaces --- packages/gatsby/src/utils/api-browser-docs.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/gatsby/src/utils/api-browser-docs.js b/packages/gatsby/src/utils/api-browser-docs.js index 4b26619e579c8..b6ae48e7799a0 100644 --- a/packages/gatsby/src/utils/api-browser-docs.js +++ b/packages/gatsby/src/utils/api-browser-docs.js @@ -81,7 +81,7 @@ exports.wrapRootComponent = true * exports.replaceHydrateFunction = () => { * return (element, container, callback) => { * console.log("rendering!"); - * ReactDOM.render(element,container,callback); + * ReactDOM.render(element, container, callback); * }; * }; */