aboutsummaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorObserverOfTime <chronobserver@disroot.org>2023-01-20 22:10:17 +0200
committerObserverOfTime <chronobserver@disroot.org>2023-01-21 14:37:07 +0200
commit341bbae864aaf868425b48d9a7caac633a9f8994 (patch)
treec74c92abde2020dc7c902fa692d7bb61f614db02 /CONTRIBUTING.md
parentUpdate parsers: c_sharp, erlang, ini, php, pug, scala (#4191) (diff)
downloadnvim-treesitter-341bbae864aaf868425b48d9a7caac633a9f8994.tar
nvim-treesitter-341bbae864aaf868425b48d9a7caac633a9f8994.tar.gz
nvim-treesitter-341bbae864aaf868425b48d9a7caac633a9f8994.tar.bz2
nvim-treesitter-341bbae864aaf868425b48d9a7caac633a9f8994.tar.lz
nvim-treesitter-341bbae864aaf868425b48d9a7caac633a9f8994.tar.xz
nvim-treesitter-341bbae864aaf868425b48d9a7caac633a9f8994.tar.zst
nvim-treesitter-341bbae864aaf868425b48d9a7caac633a9f8994.zip
docs: fix comment alignment
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md47
1 files changed, 24 insertions, 23 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 90084f049..fd858d459 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -139,32 +139,33 @@ effect on highlighting. We will work on improving highlighting in the near futur
#### Keywords
```scheme
-@keyword ; various keywords
-@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.return ; keywords like `return` and `yield`
+@keyword ; various keywords
+@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.return ; keywords like `return` and `yield`
-@conditional ; keywords related to conditionals (e.g. `if` / `else`)
-@conditional.ternary ; Ternary operator: condition ? 1 : 2
-@repeat ; keywords related to loops (e.g. `for` / `while`)
-@debug ; keywords related to debugging
-@label ; GOTO and other labels (e.g. `label:` in C)
-@include ; keywords for including modules (e.g. `import` / `from` in Python)
-@exception ; keywords related to exceptions (e.g. `throw` / `catch`)
+@conditional ; keywords related to conditionals (e.g. `if` / `else`)
+@conditional.ternary ; ternary operator (e.g. `?` / `:`)
+
+@repeat ; keywords related to loops (e.g. `for` / `while`)
+@debug ; keywords related to debugging
+@label ; GOTO and other labels (e.g. `label:` in C)
+@include ; keywords for including modules (e.g. `import` / `from` in Python)
+@exception ; keywords related to exceptions (e.g. `throw` / `catch`)
```
#### Types
```scheme
-@type ; type or class definitions and annotations
-@type.builtin ; built-in types
-@type.definition ; type definitions (e.g. `typedef` in C)
-@type.qualifier ; type qualifiers (e.g. `const`)
+@type ; type or class definitions and annotations
+@type.builtin ; built-in types
+@type.definition ; type definitions (e.g. `typedef` in C)
+@type.qualifier ; type qualifiers (e.g. `const`)
-@storageclass ; modifiers that affect storage in memory or life-time
-@attribute ; attribute annotations (e.g. Python decorators)
-@field ; object and struct fields
-@property ; similar to `@field`
+@storageclass ; modifiers that affect storage in memory or life-time
+@attribute ; attribute annotations (e.g. Python decorators)
+@field ; object and struct fields
+@property ; similar to `@field`
```
#### Identifiers
@@ -173,9 +174,9 @@ effect on highlighting. We will work on improving highlighting in the near futur
@variable ; various variable names
@variable.builtin ; built-in variable names (e.g. `this`)
-@constant ; constant identifiers
-@constant.builtin ; built-in constant values
-@constant.macro ; constants defined by the preprocessor
+@constant ; constant identifiers
+@constant.builtin ; built-in constant values
+@constant.macro ; constants defined by the preprocessor
@namespace ; modules or namespaces
@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.
-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.
The definition can be used in the scope the function was defined in.