Skip to content

Commit 9726fec

Browse files
committed
minor copy tweaks
1 parent db4317c commit 9726fec

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

packages/cursorless-org-docs/src/docs/contributing/adding-a-new-scope.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ We have a bulk test recorder for scope tests. You can use it by running Cursorle
4848

4949
When you're done, say `"cursorless save scope"` to save the tests to the appropriate files in the `data/fixtures/recorded/scopes` directory.
5050

51+
This step will create partial tests for each of the facets of the given scope. Once you've implemented the scopes in step 5 below, you can automatically update these tests to include the scope ranges, as described in step 6.
52+
5153
## 5. Add parse tree patterns for the given scope
5254

5355
Launch your extension in debug mode and open a file in your language. You can create one or more files in [`playground/`](../../../../../data/playground) and feel free to include those in your PR.
@@ -69,7 +71,7 @@ The tests generated in step 4 only include the code example. Now that you've tol
6971

7072
1. Say `"debug edit subset"` and alter the file to include just the name of your language
7173
2. Run the `Update fixtures subset` launch configuration to update your fixtures.
72-
3. Check that the fixtures now look as expected, and no other tests for your language have been altered. The VSCode source control side bar is useful for this purpose.
74+
3. Check that the fixtures now look as expected, and no other tests for your language have been altered. The VSCode source control side bar is useful for this purpose. For help understanding the scope test format, see the [scope test format docs](./scope-test-format.md)
7375

7476
## 7. File a PR!
7577

packages/cursorless-org-docs/src/docs/contributing/scope-test-format.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Scope test format
22

3+
We have a custom format we use to test that our scopes are correct. The format is automatically generated, so you shouldn't need to edit it yourself. See [Step 6 of the adding a new scope guide](./adding-a-new-scope.md#6-update-the-tests) for more information.
4+
35
## Example
46

57
Example of `.scope` file for the javascript if statement scope.

0 commit comments

Comments
 (0)