Update documentation

Co-authored-by: Henry Mercer <henry@henrymercer.name>
github · Jan 25, 2024 · c97e81c · c97e81c
1 parent 757ff40
commit c97e81c
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/src/environment.ts b/src/environment.ts
@@ -1,4 +1,8 @@
-// NB: prefix these variables with `CODEQL_ACTION` to reduce risk of their being overwritten by other steps. */
+/**
+ * Environment variables used by the CodeQL Action.
+ *
+ * We recommend prefixing environment variables with `CODEQL_ACTION_` to reduce the risk that they are overwritten by other steps.
+ */
 export enum EnvVar {
   /** Whether the `analyze` Action completes successfully. */
   ANALYZE_DID_COMPLETE_SUCCESSFULLY = "CODEQL_ACTION_ANALYZE_DID_COMPLETE_SUCCESSFULLY",