benbot/nvim-treesitter
1
0
Fork 0
mirror of https://github.com/nvim-treesitter/nvim-treesitter.git synced 2026-07-18 11:20:07 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: fix comment alignment

Browse source
This commit is contained in:
ObserverOfTime 2023-01-20 22:10:17 +02:00
parent 096891a156
commit 341bbae864
1 changed files with 24 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

47
CONTRIBUTING.md
View file

@ -139,32 +139,33 @@ effect on highlighting. We will work on improving highlighting in the near futur
#### Keywords #### Keywords
```scheme ```scheme
@keyword ; various keywords @keyword ; various keywords
@keyword.function ; keywords that define a function (e.g. `func` in Go, `def` in Python) @keyword.function ; keywords that define a function (e.g. `func` in Go, `def` in Python)
@keyword.operator ; operators that are English words (e.g. `and` / `or`) @keyword.operator ; operators that are English words (e.g. `and` / `or`)
@keyword.return ; keywords like `return` and `yield` @keyword.return ; keywords like `return` and `yield`
@conditional ; keywords related to conditionals (e.g. `if` / `else`) @conditional ; keywords related to conditionals (e.g. `if` / `else`)
@conditional.ternary ; Ternary operator: condition ? 1 : 2 @conditional.ternary ; ternary operator (e.g. `?` / `:`)
@repeat ; keywords related to loops (e.g. `for` / `while`)
@debug ; keywords related to debugging @repeat ; keywords related to loops (e.g. `for` / `while`)
@label ; GOTO and other labels (e.g. `label:` in C) @debug ; keywords related to debugging
@include ; keywords for including modules (e.g. `import` / `from` in Python) @label ; GOTO and other labels (e.g. `label:` in C)
@exception ; keywords related to exceptions (e.g. `throw` / `catch`) @include ; keywords for including modules (e.g. `import` / `from` in Python)
@exception ; keywords related to exceptions (e.g. `throw` / `catch`)
``` ```
#### Types #### Types
```scheme ```scheme
@type ; type or class definitions and annotations @type ; type or class definitions and annotations
@type.builtin ; built-in types @type.builtin ; built-in types
@type.definition ; type definitions (e.g. `typedef` in C) @type.definition ; type definitions (e.g. `typedef` in C)
@type.qualifier ; type qualifiers (e.g. `const`) @type.qualifier ; type qualifiers (e.g. `const`)
@storageclass ; modifiers that affect storage in memory or life-time @storageclass ; modifiers that affect storage in memory or life-time
@attribute ; attribute annotations (e.g. Python decorators) @attribute ; attribute annotations (e.g. Python decorators)
@field ; object and struct fields @field ; object and struct fields
@property ; similar to `@field` @property ; similar to `@field`
``` ```
#### Identifiers #### Identifiers
@ -173,9 +174,9 @@ effect on highlighting. We will work on improving highlighting in the near futur
@variable ; various variable names @variable ; various variable names
@variable.builtin ; built-in variable names (e.g. `this`) @variable.builtin ; built-in variable names (e.g. `this`)
@constant ; constant identifiers @constant ; constant identifiers
@constant.builtin ; built-in constant values @constant.builtin ; built-in constant values
@constant.macro ; constants defined by the preprocessor @constant.macro ; constants defined by the preprocessor
@namespace ; modules or namespaces @namespace ; modules or namespaces
@symbol ; symbols or atoms @symbol ; symbols or atoms
@ -260,7 +261,7 @@ Used for XML-like tags.
You can set the scope of a definition by setting the `scope` property on the definition. You can set the scope of a definition by setting the `scope` property on the definition.
For example, a javascript function declaration creates a scope. The function name is captured as the definition. For example, a JavaScript function declaration creates a scope. The function name is captured as the definition.
This means that the function definition would only be available WITHIN the scope of the function, which is not the case. This means that the function definition would only be available WITHIN the scope of the function, which is not the case.
The definition can be used in the scope the function was defined in. The definition can be used in the scope the function was defined in.