hare

commit b9b10630a680d773d657bf46a73a014915d2fb33
parent 5ac18c703e1d5c12343002ffde208a106fbefad3
Author: Drew DeVault <sir@cmpwn.com>
Date:   Fri, 26 Mar 2021 10:26:39 -0400

strings::iter: add Unicode warning

Diffstat:
M
strings/iter.ha
 | 
6
++++++

1 file changed, 6 insertions(+), 0 deletions(-)
diff --git a/strings/iter.ha b/strings/iter.ha
@@ -23,6 +23,12 @@ export fn riter(src: str) iterator = {
 };
 
 // Get the next rune from an iterator, or void if there are none left.
+//
+// Be aware that a rune is not the minimum lexographical unit of language in
+// Unicode strings. If you use these runes to construct a new string,
+// reordering, editing, or omitting any of the runes without careful discretion
+// may cause linguistic errors to arise. To avoid this, you may need to use
+// [unicode::graphiter] instead.
 export fn next(iter: *iterator) (rune | void) = {
 	match (iter.push) {
 		r: rune => {