diff options
| author | Thomas Vigouroux <39092278+vigoux@users.noreply.github.com> | 2020-06-23 14:30:01 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-06-23 14:30:01 +0200 |
| commit | 35dfd7e1f471c5f470a6c51577e11b7c3b72bb60 (patch) | |
| tree | bb4f771c641d69bec52d6ac00df7e678323e45d0 /CONTRIBUTING.md | |
| parent | Fix the ":" in symbols when used in pairs (diff) | |
| download | nvim-treesitter-35dfd7e1f471c5f470a6c51577e11b7c3b72bb60.tar nvim-treesitter-35dfd7e1f471c5f470a6c51577e11b7c3b72bb60.tar.gz nvim-treesitter-35dfd7e1f471c5f470a6c51577e11b7c3b72bb60.tar.bz2 nvim-treesitter-35dfd7e1f471c5f470a6c51577e11b7c3b72bb60.tar.lz nvim-treesitter-35dfd7e1f471c5f470a6c51577e11b7c3b72bb60.tar.xz nvim-treesitter-35dfd7e1f471c5f470a6c51577e11b7c3b72bb60.tar.zst nvim-treesitter-35dfd7e1f471c5f470a6c51577e11b7c3b72bb60.zip | |
Update CONTRIBUTING.md
This makes it more readable
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 108 |
1 files changed, 59 insertions, 49 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 568a47e3b..af48cdc62 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -39,64 +39,73 @@ effect on highlighting. We will work on improving highlighting in the near futur #### Misc -`@comment` -`@error` for error `(ERROR)` nodes. -`@punctuation.delimiter` for `;` `.` `,` -`@punctuation.bracket` for `()` or `{}` +``` +@comment +@error for error (ERROR` nodes. +@punctuation.delimiter for `;` `.` `,` +@punctuation.bracket for `()` or `{}` +``` Some captures are related to language injection (like markdown code blocks). As this is not supported by neovim yet, these are optional and will not have any effect for now. -`@embedded` -`@injection` - `language` - `content` - +``` +@embedded +@injection + language + content +``` #### Constants -`@constant` - `builtin` - `macro` -`@string` - `regex` - `escape` -`@character` -`@number` -`@boolean` -`@float` +``` +@constant + builtin + macro +@string + regex + escape +@character +@number +@boolean +@float +``` #### Functions -`@function` - `builtin` - `macro` -`@parameter` +``` +@function + builtin + macro +@parameter -`@method` -`@field` or `@property` +@method +@field or @property -`@constructor` +@constructor +``` #### Keywords -`@conditional` -`@repeat` -`@label` for C/Lua-like labels -`@operator` -`@keyword` -`@exception` -`@include` keywords for including modules (e.g. import/from in Python) - -`@type` - `builtin` -`@structure` +``` +@conditional +@repeat +@label for C/Lua-like labels +@operator +@keyword +@exception +@include keywords for including modules (e.g. import/from in Python) +@type + builtin +@structure +``` ### Locals - -`@definition` for various definitions - `function` - `method` - `var` - `macro` - `type` - `field` - `doc` for documentation adjecent to a definition. E.g. +``` +@definition for various definitions + function + method + var + macro + type + field + doc for documentation adjecent to a definition. E.g. +``` ```scheme (comment)* @definition.doc @@ -104,7 +113,8 @@ are optional and will not have any effect for now. name: (field_identifier) @definition.method) ``` -`@scope` - -`@reference` +``` +@scope +@reference +``` |