status-im/nim-style-guide
2
0
Fork 0
mirror of https://github.com/status-im/nim-style-guide.git synced 2025-02-22 19:18:18 +00:00
Code Issues Projects Releases Wiki Activity

Nim 1.2 isn't current anymore, and --styleCheck:error is generally feasible (#14)

Browse Source
This commit is contained in:
tersec 2023-06-15 12:48:40 +00:00 committed by GitHub
parent 369e933e24
commit 9eebb6d613
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/formatting.naming.md
View File

@ -2,7 +2,7 @@
Always use the same identifier style (case, underscores) as the declaration.
Enable `--styleCheck:usages`.
Enable `--styleCheck:usages`, and, where feasible, `--styleCheck:error`.
* `Ref` for `ref object` types, which have surprising semantics
* `type XxxRef = ref Xxx`

4
src/formatting.style.md
View File

@ -22,8 +22,8 @@ func someLongFunctinName(
### Practical notes
* We do not use `nimpretty` - as of writing (nim 1.2), it is not stable enough for daily use:
* We do not use `nimpretty` - as of writing (Nim 1.6), it is not stable enough for daily use:
* Can break working code
* Naive formatting algorithm
* We do not make use of Nim's "flexible" identifier names - all uses of an identifier should match the declaration in capitalization and underscores
* Enable `--styleCheck:usages`
* Enable `--styleCheck:usages` and, where feasible, `--styleCheck:error`