fix params

linear-b · Sep 1, 2024 · e78cc47 · e78cc47
1 parent 5db7f85
commit e78cc47
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/plugins/filters/suggestIssues/index.js b/plugins/filters/suggestIssues/index.js
@@ -2,9 +2,10 @@
  * @module suggestIssues
  * @description Fetches ticket recommendations based on given pull request details.
  * @param {object} pr - The pull request object containing title, author, and created_at properties.
+ * @param {object} pr - The branch object containing the branch name.
  * @param {string} apiKey - The API key used to authenticate requests.
  * @returns {Array} Returns an array of suggested issues related to the current Pull Request.
- * @example {{ pr | suggestIssues(env.LINEARB_TOKEN) }}
+ * @example {{ pr | suggestIssues(branch, env.LINEARB_TOKEN) }}
  * @license MIT
 **/
 

diff --git a/plugins/filters/suggestIssues/reference.md b/plugins/filters/suggestIssues/reference.md
@@ -11,6 +11,7 @@ A gitStream plugin to suggest issues to link to the PR
 | Param  | Type     | Description                                      |
 | ------ | -------- | ------------------------------------------------ |
 | pr     | `Object` | The pull request object from gitStream's context |
+| branch | Object   | The branch object from gitStream's context       |
 | apiKey | `string` | The API key used to authenticate requests.       |