nt README.md
This commit is contained in:
parent
a7d0e34cb7
commit
0806887889
1 changed files with 5 additions and 9 deletions
14
README.md
14
README.md
|
|
@ -1,15 +1,11 @@
|
||||||
# MyNib
|
# NixTypes (nt)
|
||||||
**MyNib (My Nix Library)** is a mini lil library of utilities I find
|
|
||||||
myself frequently rewriting.
|
|
||||||
|
|
||||||
|
|
||||||
## Conventions
|
## Conventions
|
||||||
1. *"Private"* attribute set values: start and end with underscores, ie `MyType._value_`
|
1. Avoid the `with` keyword like your life depends on it!!
|
||||||
2. Modules: use the `useMod` and `mkMod` nib provides
|
Every LSP I've tried has handled them terribly. Not to mention it absolutely
|
||||||
3. Avoid the `with` keyword like your life depends on it!!
|
|
||||||
Most LSPs I've tried have handled them terribly. Not to mention it absolutely
|
|
||||||
pollutes the scoped namespace ;-; Just stick to writing out `let ... in`. And **iff**
|
pollutes the scoped namespace ;-; Just stick to writing out `let ... in`. And **iff**
|
||||||
you **absolutely** need it to condense code in a meaningful way, then isolate its
|
you **absolutely** need it to condense code in a meaningful way, then isolate its
|
||||||
use to a very **very** small scope. Not your entire file!
|
use to a very **very** small scope. Not your entire file!
|
||||||
4. All names/identifiers should be written in **camelCase**, except *"Types"* (aka specifically structured attribute sets).
|
2. All names/identifiers should be written in **camelCase**, except *"Types"* (aka specifically structured attribute sets).
|
||||||
Which should be written in **PascalCase**.
|
Which should be written in **PascalCase**. **Typeclasses** should be written in **PascalCaseWithApostrophe'**.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue