Skip to content

Commit 988b8ef

Browse files
Copilotaegilops
andcommitted
Add missing JSDoc parameter documentation for octokit
Co-authored-by: aegilops <[email protected]>
1 parent ac8ea00 commit 988b8ef

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/componentSubmission.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -180,8 +180,9 @@ export async function run(octokit: Octokit, tmpDir: string, owner: string, repo:
180180
/**
181181
* submitSnapshot submits a snapshot to the Dependency Submission API - vendored in from @github/dependency-submission-toolkit, to make it work at the CLI, vs in Actions.
182182
*
183-
* @param {Snapshot} snapshot
184-
* @param {Repo} repo
183+
* @param {Octokit} octokit - The Octokit instance for GitHub API requests
184+
* @param {Snapshot} snapshot - The dependency snapshot to submit
185+
* @param {Repo} repo - The repository owner and name
185186
* @returns {Promise<boolean>} true if submission was successful, false otherwise
186187
*/
187188
export async function submitSnapshot(

0 commit comments

Comments
 (0)