Document meaning of undefined sortState

Author: jcreedcmu

extensions/ql-vscode/src/interface-types.ts

@@ -34,6 +34,8 @@ export interface PreviousExecution {
 export interface Interpretation {
   sourceLocationPrefix: string;
   numTruncatedResults: number;
+  // sortState being undefined means don't sort, just present results in the order
+  // they appear in the sarif file.
   sortState?: InterpretedResultsSortState;
   sarif: sarif.Log;
 }
@@ -128,12 +130,16 @@ export interface InterpretedResultsSortState {
   sortDirection: SortDirection;
 }
 
+// sortState being undefined means don't sort, just present results in the order
+// they appear in the bqrs file.
 interface ChangeRawResultsSortMsg {
   t: 'changeSort';
   resultSetName: string;
   sortState?: RawResultsSortState;
 }
 
+// sortState being undefined means don't sort, just present results in the order
+// they appear in the sarif file.
 interface ChangeInterpretedResultsSortMsg {
   t: 'changeInterpretedSort';
   sortState?: InterpretedResultsSortState;