explain inline comment

2026-09-02 11:40:39 +02:00
parent 9220e3dc28
commit 6eb91f3433
1 changed files with 2 additions and 2 deletions
@@ -11,7 +11,7 @@ Be nice, we are all just doing this to have fun

 ## Documenting Functions
 All functions in the standard library should follow the following outline:
-```asm
+```
 ; <description>
 ; Arguments: <which register contains what argument>
 ; 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 that are provided for convenience/reference but should be inlined in production code should be marked with `;SHOULD BE INLINED` after their label