Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add verbose method documentation for the reporter #19199

Merged
merged 1 commit into from
Nov 4, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Add verbose method documentation for the reporter
  • Loading branch information
johnstonbl01 committed Nov 1, 2019
commit 4456379f74abae4ace499950b1d767623ac46bb4
9 changes: 9 additions & 0 deletions packages/gatsby/src/utils/api-node-helpers-docs.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,15 @@ const GatsbyReporter = {
* reporter.panicOnBuild(`text`, new Error('something'))
*/
panicOnBuild: true,

/**
* Note that this method only works if the --verbose option has
* been passed to the CLI
* @type {GatsbyReporterFn}
* @example
* reporter.verbose(`text`)
*/
verbose: true,
};

/** */
Expand Down