Update documentation

angelapwen · henrymercer · web-flow · commit c97e81c8df06 · 2024-01-25T03:00:32.000-08:00
Co-authored-by: Henry Mercer &lt;henry@henrymercer.name&gt;
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",
