Fix type annotations for Octokit

WordPress · Nov 22, 2023 · 4e5a052 · 4e5a052
1 parent ba06d19
commit 4e5a052
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/automations/js/src/project_automation/issues.mjs b/automations/js/src/project_automation/issues.mjs
@@ -3,7 +3,7 @@ import { getBoard } from '../utils/projects.mjs'
 /**
  * This is the entrypoint of the script.
  *
- * @param octokit {import('octokit').Octokit} the Octokit instance to use
+ * @param octokit {import('@octokit/rest').Octokit} the Octokit instance to use
  * @param context {import('@actions/github').context} info about the current event
  */
 export const main = async (octokit, context) => {

diff --git a/automations/js/src/project_automation/prs.mjs b/automations/js/src/project_automation/prs.mjs
@@ -6,7 +6,7 @@ import { PullRequest } from '../utils/pr.mjs'
 /**
  * This is the entrypoint of the script.
  *
- * @param octokit {import('octokit').Octokit} the Octokit instance to use
+ * @param octokit {import('@octokit/rest').Octokit} the Octokit instance to use
  */
 export const main = async (octokit) => {
   const { eventName, eventAction } = JSON.parse(

diff --git a/automations/js/src/utils/pr.mjs b/automations/js/src/utils/pr.mjs
@@ -18,7 +18,7 @@ export class PullRequest {
    *                    ^^^^^^^^^ ^^^^^^^^^^     ^^^^
    *                    owner     repo           number
    *
-   * @param octokit {import('octokit').Octokit} the Octokit instance to use
+   * @param octokit {import('@octokit/rest').Octokit} the Octokit instance to use
    * @param owner {string} the login of the owner (org) of the project
    * @param repo {string} the name of the repository
    * @param number {number} the number of the project

diff --git a/automations/js/src/utils/projects.mjs b/automations/js/src/utils/projects.mjs
@@ -26,7 +26,7 @@ class Project {
    *                         ^^^^^^^^^          ^^
    *                         owner              number
    *
-   * @param octokit {import('octokit').Octokit} the Octokit instance to use
+   * @param octokit {import('@octokit/rest').Octokit} the Octokit instance to use
    * @param owner {string} the login of the owner (org) of the project
    * @param number {number} the number of the project
    */
@@ -212,7 +212,7 @@ class Project {
 /**
  * Get the `Project` instance for the project board with the given name.
  *
- * @param octokit {import('octokit').Octokit} the Octokit instance to use
+ * @param octokit {import('@octokit/rest').Octokit} the Octokit instance to use
  * @param name {string} the name of the project (without the 'Openverse' prefix)
  * @returns {Project} the `Project` instance to interact with the project board
  */