Add comment to formatLegacyMessage

koesie10 · koesie10 · commit 76534bccd7ac · 2023-12-04T10:58:57.000+01:00
diff --git a/extensions/ql-vscode/src/query-server/format-legacy-message.ts b/extensions/ql-vscode/src/query-server/format-legacy-message.ts
@@ -1,5 +1,7 @@
 import * as legacyMessages from "./legacy-messages";
 
+// Used for formatting the result of a legacy query which might still be in the
+// user's query history.
 export function formatLegacyMessage(result: legacyMessages.EvaluationResult) {
   switch (result.resultType) {
     case legacyMessages.QueryResultType.CANCELLATION:
