From 5d2b8665183de74bb4b23ee4e7d6c5a05e854299 Mon Sep 17 00:00:00 2001
From: Thomas Vigouroux <tomvig38@gmail.com>
Date: Mon, 7 Sep 2020 12:07:17 +0200
Subject: ci: check capture names in queries

---
 CONTRIBUTING.md | 59 ++++++++++++++++++++++++++++++++++-----------------------
 1 file changed, 35 insertions(+), 24 deletions(-)

(limited to 'CONTRIBUTING.md')

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 902e4532..70280e78 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -84,19 +84,20 @@ are optional and will not have any effect for now.
 ```
 @embedded
 @injection
-  language
-  content
+@injection.language
+@injection.content
 ```
 
 #### Constants
 
 ```
 @constant
-  builtin
-  macro
+@constant.builtin
+@constant.macro
 @string
-  regex
-  escape
+@string.regex
+@string.escape
+@string.special
 @character
 @number
 @boolean
@@ -107,13 +108,13 @@ are optional and will not have any effect for now.
 
 ```
 @function
-  builtin
-  macro
+@function.builtin
+@function.macro
 @parameter
-  reference references to parameters
 
 @method
-@field or @property
+@field
+@property
 
 @constructor
 ```
@@ -126,19 +127,20 @@ are optional and will not have any effect for now.
 @label for C/Lua-like labels
 @operator
 @keyword
-  function
+@keyword.function
 @exception
 @include keywords for including modules (e.g. import/from in Python)
 
 @type
-    builtin
+@type.builtin
 @structure
+@attribute for e.g. Python decorators
 ```
 
 #### Variables
 ```
 @variable
-  builtin
+@variable.builtin
 ```
 
 #### Text
@@ -158,15 +160,19 @@ Mainly for markup languages.
 ### Locals
 ```
 @definition for various definitions
-  function
-  method
-  var
-  macro
-  type
-  field
-  namespace for modules or C++ namespaces
-  import for imported names
-  doc for documentation adjacent to a definition. E.g.
+@definition.function
+@definition.method
+@definition.var
+@definition.parameter
+@definition.macro
+@definition.type
+@definition.field
+@definition.enum
+@definition.namespace for modules or C++ namespaces
+@definition.import for imported names
+
+@definition.associated to determine the type of a variable
+@definition.doc for documentation adjacent to a definition. E.g.
 ```
 
 ```scheme
@@ -178,6 +184,7 @@ Mainly for markup languages.
 ```
 @scope
 @reference
+@constructor
 ```
 
 #### Definition Scope
@@ -208,7 +215,11 @@ Possible scope values are:
 
 ### Folds
 
-You can define folds for a given language by adding a `fold.scm` query.
-The `@fold` capture is used to fold a node.
+You can define folds for a given language by adding a `fold.scm` query :
+
+```
+@fold
+```
+
 If the `fold.scm` query is not present, this will fallback to the `@scope` captures in the `locals`
 query.
-- 
cgit v1.2.3