Skip to content

Commit 92c0a7f

Browse files
Add section about Abbreviations to contributing docs
1 parent 44ca42d commit 92c0a7f

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

CONTRIBUTING.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -250,6 +250,16 @@ def f(x: float) -> float:
250250
return 1/(x*x)
251251
```
252252

253+
### Abbreviations
254+
255+
We keep the abbreviations used in the documentation inside the
256+
[docs_include/abbreviations.md](docs_includes%2Fabbreviations.md) file.
257+
258+
The syntax for abbreviations is:
259+
260+
```markdown
261+
*[ABBR]: Abbreviation
262+
```
253263

254264
## CI
255265

0 commit comments

Comments
 (0)