From f2e5c830b345173c577c6e4a983f2c4833dfe70e Mon Sep 17 00:00:00 2001 From: ShatteredMINT Date: Tue, 1 Sep 2026 13:48:12 +0200 Subject: [PATCH] explain inline comment --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 610468a..82a0201 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 +``` ; ; Arguments: ; Result: @@ -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