diff --git a/lib/context.js b/lib/context.js index 5d5b2d1f..8589fe9f 100644 --- a/lib/context.js +++ b/lib/context.js @@ -63,17 +63,17 @@ class Context { } /** - * Reads the plugin configuration from the given YAML file name in the - * `.github` directory. + * Reads the plugin configuration from the given YAML file in the `.github` + * directory of the repository. * * @example * - * // Load config from .github/myplugin.yml in the repository - * const config = await context.config('myplugin.yml'); - * - * if(config.close) { - * context.github.issues.edit(context.issue({state: 'closed'})); - * } + // Load config from .github/myplugin.yml in the repository + const config = await context.config('myplugin.yml'); + + if(config.close) { + context.github.issues.edit(context.issue({state: 'closed'})); + } * * @param {string} fileName Name of the YAML file in the `.github` directory * @return {Promise} Configuration object read from the file