add explanatory code comment

mdb · Aug 18, 2022 · 0fe2fae · 0fe2fae
1 parent 5dc1e6d
commit 0fe2fae
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/main.go b/main.go
@@ -89,6 +89,9 @@ type wordle struct {
 	evaluations [maxGuesses][wordLength]evaluation
 
 	// keyboardChars is a slice of all keyboard characters
+	// Because Go does preserve the order of maps, keyboardChars
+	// stores the keyboard key characters in the order in which
+	// they typically appear on many keyboards.
 	keyboardChars []rune
 
 	// keyboard is a map of alphabetical keyboard keys to an evaluation of each key character