Skip to content

Commit 130ab2d

Browse files
committed
Improve JSDoc
1 parent 8cf2dc5 commit 130ab2d

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

src/languages/index.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,13 @@ export function isBuiltInLanguage(
3434
}
3535

3636
/**
37-
* Parses a built-in language name or alias.
37+
* Parse a language input corresponding to a built-in language into its canonical CodeQL language
38+
* name.
39+
*
40+
* This uses the language aliases shipped with the Action and will not be able to resolve aliases
41+
* added by third-party CodeQL language support or versions of the CodeQL CLI newer than the one
42+
* mentioned in `defaults.json`. Therefore, this function should only be used when the CodeQL CLI is
43+
* not available.
3844
*/
3945
export function parseBuiltInLanguage(
4046
language: string,

0 commit comments

Comments
 (0)