Micha_i/symphony_stdlib
1
0
Fork 0
forked from TCShenanigans/symphony_stdlib
Code Pull Requests Activity

explain inline comment

Browse Source
This commit is contained in:
ShatteredMINT
2026-09-01 13:48:12 +02:00
parent 60e7b6209f
commit f2e5c830b3
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
CONTRIBUTING.md
+2 -2
View File
@@ -11,7 +11,7 @@ Be nice, we are all just doing this to have fun
## Documenting Functions ## Documenting Functions
All functions in the standard library should follow the following outline: All functions in the standard library should follow the following outline:
```asm ```
; <description> ; <description>
; Arguments: <which register contains what argument> ; Arguments: <which register contains what argument>
; Result: <what is the result, and where is it stored> ; Result: <what is the result, and where is it stored>
@@ -22,4 +22,4 @@ fn_label: <;SHOULD BE INLINED>
``` ```
Functions should be in the appropriate asm file, if you are unsure where functionality fits make a seperate file and ask in the pull request Functions should be in the appropriate asm file, if you are unsure where functionality fits make a seperate file and ask in the pull request
Functions that are provided for convenience/reference but should be inlined in production code should be marked with `;SHOULD BE INLINED` after their label