diff --git a/client/coral-framework/hocs/withMutation.js b/client/coral-framework/hocs/withMutation.js index c31e89ce8..d30598cf0 100644 --- a/client/coral-framework/hocs/withMutation.js +++ b/client/coral-framework/hocs/withMutation.js @@ -237,6 +237,10 @@ const createHOC = (document, config, { notifyOnError = true }) => /** * Exports a HOC with the same signature as `graphql`, that will * apply mutation options registered in the graphRegistry. + * + * The returned HOC accepts a settings object with the following properties: + * notifyOnError: show a notification to the user when an error occured. + * Defaults to true, requires the `notify` action to be mounted. */ export default (document, config = {}) => settingsOrComponent => { if (typeof settingsOrComponent === 'function') { diff --git a/client/coral-framework/hocs/withQuery.js b/client/coral-framework/hocs/withQuery.js index 08556b1b3..ec5433609 100644 --- a/client/coral-framework/hocs/withQuery.js +++ b/client/coral-framework/hocs/withQuery.js @@ -346,6 +346,10 @@ const createHOC = (document, config, { notifyOnError = true }) => /** * Exports a HOC with the same signature as `graphql`, that will * apply query options registered in the graphRegistry. + * + * The returned HOC accepts a settings object with the following properties: + * notifyOnError: show a notification to the user when an error occured. + * Defaults to true, requires the `notify` action to be mounted. */ export default (document, config = {}) => settingsOrComponent => { if (typeof settingsOrComponent === 'function') {