Improves API docs

danger · Jan 14, 2018 · 75e1c6b · 75e1c6b
1 parent c14e46c
commit 75e1c6b
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/source/dsl/GitHubDSL.ts b/source/dsl/GitHubDSL.ts
@@ -22,7 +22,11 @@ export interface GitHubJSONDSL {
 
 /** The GitHub metadata for your PR */
 export interface GitHubDSL extends GitHubJSONDSL {
-  /** An authenticated API so you can extend danger's behavior. An instance of the "github" npm module. */
+  /**
+   * An authenticated API so you can extend danger's behavior by using the [GitHub v3 API](https://developer.github.com/v3/).
+   *
+   * A set up instance of the "github" npm module. You can get the full [API here](https://octokit.github.io/node-github/).
+   */
   api: GitHub
   /** A scope for useful functions related to GitHub */
   utils: GitHubUtilsDSL