aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorPhạm Huy Hoàng <hoangtun0810@gmail.com>2024-02-27 01:00:55 +0900
committerChristian Clason <c.clason@uni-graz.at>2025-05-12 18:43:40 +0200
commit429e6f446b7f2e3201fa940b897414db73047634 (patch)
tree4fb37971c8b9a79c06cceb2aefe5c7d8b12b6ebb /CONTRIBUTING.md
parentfix(format): update scripts to support nightly (#6126) (diff)
downloadnvim-treesitter-429e6f446b7f2e3201fa940b897414db73047634.tar
nvim-treesitter-429e6f446b7f2e3201fa940b897414db73047634.tar.gz
nvim-treesitter-429e6f446b7f2e3201fa940b897414db73047634.tar.bz2
nvim-treesitter-429e6f446b7f2e3201fa940b897414db73047634.tar.lz
nvim-treesitter-429e6f446b7f2e3201fa940b897414db73047634.tar.xz
nvim-treesitter-429e6f446b7f2e3201fa940b897414db73047634.tar.zst
nvim-treesitter-429e6f446b7f2e3201fa940b897414db73047634.zip
doc: better clarification of highlights/injections
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index b7ecb5690..55c0bc284 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -72,7 +72,8 @@ For these types there is a _norm_ you will have to follow so that features work
Here are some global advices:
- Examples of queries can be found in [runtime/queries/](runtime/queries/)
-- Note that (unlike tree-sitter) all matching patterns are applied, with the last one determining the visible highlight.
+- For highlights, all matching patterns are applied, with the last one determining the visible capture & highlight.
+- For injections, try your best to ensure that each captured node is only matched by a single pattern.
- If the [parser is included in `nvim-treesitter`](https://github.com/nvim-treesitter/nvim-treesitter/SUPPORTED_LANGUAGES.md`) and installed with `:TSInstall`, you can use Neovim's developer tools (`:checkhealth`, `:InspectTree`, `:EditQuery`, `:Inspect`) to test your queries.
#### Inheriting languages