Skip to content

Commit fa18cc9

Browse files
committed
Improve docstrings for language types
1 parent bf692c0 commit fa18cc9

File tree

3 files changed

+13
-6
lines changed

3 files changed

+13
-6
lines changed

lib/languages.js

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

lib/languages.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/languages.ts

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1+
/** A language supported by CodeQL. */
2+
export type Language = string;
3+
14
/**
2-
* A CodeQL language.
5+
* A language supported by CodeQL that is treated specially by the Action.
36
*
4-
* To facilitate adding new languages, this is a typedef rather than an
5-
* exhaustive list of languages supported by CodeQL.
7+
* This is not an exhaustive list of languages supported by CodeQL and new
8+
* languages do not need to be added here.
69
*/
7-
export type Language = string;
8-
910
export enum KnownLanguage {
1011
csharp = "csharp",
1112
cpp = "cpp",

0 commit comments

Comments
 (0)