Skip to content

Commit 1b76159

Browse files
committed
Fix quotes
1 parent 30e614e commit 1b76159

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

extensions/ql-vscode/docs/test-plan.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ We don't need to test features (and permutations of features) that are covered b
1212
- Go through the required test cases listed below
1313
- Check major PRs since the previous release for specific one-off things to test. Based on that, you might want to
1414
choose to go through some of the Optional Test Cases.
15-
- Run a query using the existing version of the extension (to generate an old query history item)
15+
- Run a query using the existing version of the extension (to generate an "old" query history item)
1616

1717
## Required Test Cases
1818

@@ -34,7 +34,7 @@ choose to go through some of the Optional Test Cases.
3434
3. Check that a notification message pops up and the results view is opened.
3535
4. Check the query history. It should:
3636
- Show that an item has been added to the query history
37-
- The item should be marked as in progress.
37+
- The item should be marked as "in progress".
3838
5. Once the query starts:
3939
- Check the results view
4040
- Check the code paths view, including the code paths drop down menu.
@@ -53,7 +53,7 @@ choose to go through some of the Optional Test Cases.
5353
- Provide a link to the actions workflow
5454
4. Check the query history. It should:
5555
- Show that an item has been added to the query history
56-
- The item should be marked as in progress.
56+
- The item should be marked as "in progress".
5757
5. Once the query starts:
5858
- Check that a notification is shown with a link to the results view
5959
- Check that the results are rendered with an alert message and a highlighted code snippet:
@@ -131,25 +131,25 @@ These are mostly aimed at MRVA, but some of them are also applicable to non-MRVA
131131
2. Can run queries on private repositories
132132
3. The controller repo exists but you do not have write access
133133
4. The controller repo doesn’t exist
134-
5. The config field for the controller repo is not set
134+
5. The "config field" for the controller repo is not set
135135

136136
### Query History
137137
1. Query history is loaded when vscode starts
138138
- Handles when action workflow was cancelled while vscode was closed
139139
- Starts monitoring variant analyses
140-
- When variant analysis state is pending
141-
- When variant analysis state is in_progress
142-
- When variant analysis state is succeded
140+
- When variant analysis state is "pending"
141+
- When variant analysis state is "in_progress"
142+
- When variant analysis state is "succeded"
143143
- All results are downloaded
144144
- Not all results are downloaded
145-
- When variant analysis state is failed
145+
- When variant analysis state is "failed"
146146
- Stops monitoring
147147
2. Can open query history item
148148
- Manually by clicking on them
149149
- Automatically when vscode starts (if they were open when vscode was last used)
150150
3. Can delete a query history item
151151
- Item is removed from list in UI
152-
- Files on dist are deleted (can get to files using open query directory)
152+
- Files on dist are deleted (can get to files using "open query directory")
153153
4. Can sort query history items
154154
- By name
155155
- By query date
@@ -187,11 +187,11 @@ These are mostly aimed at MRVA, but some of them are also applicable to non-MRVA
187187

188188
### Results view
189189
1. Can open a results view
190-
- When variant analysis state is pending
191-
- When variant analysis state is in_progress
192-
- When variant analysis state is succeeded
193-
- When variant analysis state is failed
194-
- When variant analysis state is canceled
190+
- When variant analysis state is "pending"
191+
- When variant analysis state is "in_progress"
192+
- When variant analysis state is "succeeded"
193+
- When variant analysis state is "failed"
194+
- When variant analysis state is "canceled"
195195
2. Results view opens automatically
196196
- When starting variant analysis run
197197
- When vscode opens (if view was open when vscode was closed)
@@ -215,10 +215,10 @@ See section from query history.
215215
- Duration
216216
13. Can see live results
217217
- Results appear in extension as soon as each query is completed
218-
14. Can view interpreted results (i.e. for a problem query)
218+
14. Can view interpreted results (i.e. for a "problem" query)
219219
- Can view non-path results
220-
- Can view code paths for path-problem queries
221-
15. Can view raw results (i.e. for a non problem query)
220+
- Can view code paths for "path-problem" queries
221+
15. Can view raw results (i.e. for a non "problem" query)
222222
- Renders a table
223223
16. Can see skipped repositories
224224
- Can see repos with no db in a tab
@@ -228,7 +228,7 @@ See section from query history.
228228
- Only shows tab when there are skipped repos
229229
17. Result downloads
230230
- All results are downloaded automatically
231-
- Download status is indicated by a spinner (Not currently any indication of progress beyond downloading and not downloading)
231+
- Download status is indicated by a spinner (Not currently any indication of progress beyond "downloading" and "not downloading")
232232
- Only 3 items are downloaded at a time
233233
- Results for completed queries are still downloaded when
234234
- Some but not all queries failed

0 commit comments

Comments
 (0)