Improves API docs

danger · Jan 14, 2018 · 46b0c7f · 46b0c7f
1 parent c14e46c
commit 46b0c7f
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/source/danger.d.ts b/source/danger.d.ts
@@ -308,7 +308,11 @@ declare module "danger" {
 
   /** The GitHub metadata for your PR */
   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

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