Update API docs

This commit is contained in:
Brandon Keepers 2017-07-27 09:43:18 -05:00
parent 794064f242
commit b70e6af7b1
No known key found for this signature in database
GPG Key ID: F9533396D5FACBF6
1 changed files with 3 additions and 5 deletions

View File

@ -63,12 +63,10 @@ class Context {
}
/**
* Reads the plugin configuration from the given file name in the `.github` directory.
* Reads the plugin configuration from the given YAML file name in the
* `.github` directory.
*
* @param {github} github Authenticated GitHub API client
* @param {string} owner Owner of the repository
* @param {string} repo Name of the repository
* @param {string} fileName Name of the configuration file within the `.github` directory
* @param {string} fileName Name of the YAML file in the `.github` directory
* @return {Promise<Object>} Configuration object read from the file
*/
async config(fileName) {