kodin/ableos-idl
1
0
Fork 0
forked from AbleOS/ableos
Code Pull requests Activity

Magic function style guide

Browse source
This commit is contained in:
Able 2024-11-24 23:50:46 -06:00
parent 0b57c2e9bb
commit bdb762c986
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
STYLE_GUIDE.md
View file

@ -21,6 +21,17 @@ a := fn(): void {}
/// in fat32.hb /// in fat32.hb
a := fn(): void {} a := fn(): void {}
``` ```
## Magic Functions | loose
'Magic functions' are what I am calling small helper functions that do one or two things.
### Example
```rust
a := null
magic_a := fn(){
a = 10
}
```
The exact policy I want to have here is a bit fuzzy. I think that functions like this are nice in certain situations and not in others.
Regardless of if you use them or not, put a comment above the function explaining rational.
## Magic Numbers | loose ## Magic Numbers | loose