Skip to content

Commit

Permalink
docs: Replaced myapp.yml with config.yml (#471)
Browse files Browse the repository at this point in the history
  • Loading branch information
Abhijeet Singh authored and bkeepers committed Mar 22, 2018
1 parent 3503b1f commit 05e063f
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions lib/context.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ class Context {
*
* @example
*
* const params = context.repo({path: '.github/stale.yml'})
* // Returns: {owner: 'username', repo: 'reponame', path: '.github/stale.yml'}
* const params = context.repo({path: '.github/config.yml'})
* // Returns: {owner: 'username', repo: 'reponame', path: '.github/config.yml'}
*
*/
repo (object) {
Expand Down Expand Up @@ -68,15 +68,15 @@ class Context {
* Reads the app configuration from the given YAML file in the `.github`
* directory of the repository.
*
* @example <caption>Contents of <code>.github/myapp.yml</code>.</caption>
* @example <caption>Contents of <code>.github/config.yml</code>.</caption>
*
* close: true
* comment: Check the specs on the rotary girder.
*
* @example <caption>App that reads from <code>.github/myapp.yml</code>.</caption>
* @example <caption>App that reads from <code>.github/config.yml</code>.</caption>
*
* // Load config from .github/myapp.yml in the repository
* const config = await context.config('myapp.yml')
* // Load config from .github/config.yml in the repository
* const config = await context.config('config.yml')
*
* if (config.close) {
* context.github.issues.comment(context.issue({body: config.comment}))
Expand All @@ -85,8 +85,8 @@ class Context {
*
* @example <caption>Using a <code>defaultConfig</code> object.</caption>
*
* // Load config from .github/myapp.yml in the repository and combine with default config
* const config = await context.config('myapp.yml', {comment: 'Make sure to check all the specs.'})
* // Load config from .github/config.yml in the repository and combine with default config
* const config = await context.config('config.yml', {comment: 'Make sure to check all the specs.'})
*
* if (config.close) {
* context.github.issues.comment(context.issue({body: config.comment}));
Expand Down

0 comments on commit 05e063f

Please sign in to comment.