Update getMlPoweredJsQueriesStatus doc

This commit is contained in:
Henry Mercer
2022-02-04 17:15:02 +00:00
parent ad40e4a8f8
commit 501fe7ff12
3 changed files with 11 additions and 7 deletions

View File

@@ -631,14 +631,16 @@ export function checkNotWindows11() {
export const ML_POWERED_JS_QUERIES_PACK_NAME =
"codeql/javascript-experimental-atm-queries";
/** Get information about ML-powered JS queries to populate status reports with.
/**
* Get information about ML-powered JS queries to populate status reports with.
*
* This will be:
*
* - The version string if the analysis will use a specific version of the pack
* - "latest" if the analysis will use the latest version of the pack
* - "false" if the analysis won't run any ML-powered JS queries, or if the analysis will run
* multiple ML-powered JS query packs
* - "false" if the analysis won't run any ML-powered JS queries
* - "multiple" if the analysis will run multiple ML-powered JS query packs (this is an unsupported
* scenario)
*
* This function lives here rather than in `init-action.ts` so it's easier to test, since tests for
* `init-action.ts` would each need to live in their own file. See `analyze-action-env.ts` for an