From 12ae44d5631c204d6069f43c13049fc9cd33d69f Mon Sep 17 00:00:00 2001
From: James Shubin <james@shubin.ca>
Date: Thu, 4 Aug 2022 14:34:18 -0400
Subject: [PATCH] lang: funcs: core: fmt: Add important comment to printf

---
 lang/funcs/core/fmt/printf_func.go | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/lang/funcs/core/fmt/printf_func.go b/lang/funcs/core/fmt/printf_func.go
index ab4a3676..5dd41b3f 100644
--- a/lang/funcs/core/fmt/printf_func.go
+++ b/lang/funcs/core/fmt/printf_func.go
@@ -61,6 +61,8 @@ func (obj *PrintfFunc) ArgGen(index int) (string, error) {
 	if index == 0 {
 		return formatArgName, nil
 	}
+	// TODO: if index is big enough that it would return the string in
+	// `formatArgName` then we should return an error! (Nearly impossible.)
 	return util.NumToAlpha(index - 1), nil
 }