actions/codeql-action
1
0
Fork 0
mirror of https://github.com/github/codeql-action synced 2026-05-31 00:00:46 +03:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1296 from github/edoardo/improve-docs

Browse Source 
Improve documentation comment
This commit is contained in:
Edoardo Pirovano
2022-10-12 08:35:01 +01:00
committed by GitHub
parent 099de40ecf 082bdf06b5
commit e862e8fc76
3 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/util.js
Generated
+3 -2
View File
@@ -748,8 +748,9 @@ exports.tryGetFolderBytes = tryGetFolderBytes;
* Run a promise for a given amount of time, and if it doesn't resolve within
* that time, call the provided callback and then return undefined.
*
* Note that this does NOT cancel the original promise, so that promise will
* continue in the background even after the timeout has expired.
* Important: This does NOT cancel the original promise, so that promise will
* continue in the background even after the timeout has expired. If the
* original promise hangs, then this will prevent the process terminating.
*
* @param timeoutMs The timeout in milliseconds.
* @param promise The promise to run.
lib/util.js.map
+1 -1
View File
File diff suppressed because one or more lines are too long
src/util.ts
+3 -2
View File
@@ -899,8 +899,9 @@ export async function tryGetFolderBytes(
* Run a promise for a given amount of time, and if it doesn't resolve within
* that time, call the provided callback and then return undefined.
*
* Note that this does NOT cancel the original promise, so that promise will
* continue in the background even after the timeout has expired.
* Important: This does NOT cancel the original promise, so that promise will
* continue in the background even after the timeout has expired. If the
* original promise hangs, then this will prevent the process terminating.
*
* @param timeoutMs The timeout in milliseconds.
* @param promise The promise to run.