Sulkta-OSS/agora
3
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

general neatening

Browse source
This commit is contained in:
Jack Hodgkinson 2022-02-07 10:26:43 +00:00
parent eacbe991a5
commit ad881e8d01
3 changed files with 21 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

11
docs/meta/style-guide.md
View file

@ -9,9 +9,18 @@ The following words should always be render capitalised:
- Agora
- Liqwid
- LiqwidX
- Nix
- NixOS
- Plutus
- Plutarch
Sensible exceptions naturally exist, including referencing shell commands (`nix-shell`) or code:
```haskell
plutarchTerm :: Term s a
plutarchTerm = ...
```
## Upper-case terms
The following terms should always be rendered in all capital letters:
@ -29,4 +38,4 @@ The following words should always be rendered lower-case (unless used at the beg
The following practices should be avoided:
- The use of '&' apart from in proper nouns such as AT&T or commonly-understood abbreviations such as 'R&D'.
- The use of '&' apart from in proper nouns such as AT\&T.