aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorChris Kipp <ckipp@pm.me>2023-03-27 12:52:40 +0200
committerStephan Seitz <stephan.seitz@fau.de>2023-04-03 01:54:02 -0700
commit9711139326284ddb2c6f1d29783a162c08b47bb8 (patch)
tree16ff502abb2878d6a465cc12d53c0a4868117250 /CONTRIBUTING.md
parentfeat: use `-bundle` to build parsers on macOS (diff)
downloadnvim-treesitter-9711139326284ddb2c6f1d29783a162c08b47bb8.tar
nvim-treesitter-9711139326284ddb2c6f1d29783a162c08b47bb8.tar.gz
nvim-treesitter-9711139326284ddb2c6f1d29783a162c08b47bb8.tar.bz2
nvim-treesitter-9711139326284ddb2c6f1d29783a162c08b47bb8.tar.lz
nvim-treesitter-9711139326284ddb2c6f1d29783a162c08b47bb8.tar.xz
nvim-treesitter-9711139326284ddb2c6f1d29783a162c08b47bb8.tar.zst
nvim-treesitter-9711139326284ddb2c6f1d29783a162c08b47bb8.zip
docs: add a small note about local queries
This just adds a small note in the CONTRIBUTING section about local queries and how they differ from those listed upstream.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md6
1 files changed, 6 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d809bc784..2d1a16a0b 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -240,6 +240,12 @@ Used for XML-like tags.
### Locals
+Note: pay specific attention to the captures here as they are a bit different to
+those listed in the upstream [Local Variables
+docs](https://tree-sitter.github.io/tree-sitter/syntax-highlighting#local-variables).
+Some of these docs didn't exist when `nvim-treesitter` was created and the
+upstream captures are more limiting than what we have here.
+
```scheme
@definition ; various definitions
@definition.constant ; constants