Merge pull request #6145 from roc-lang/improve-str-docs

Fix Str.walkUtf8 docs
roc-lang · Dec 2, 2023 · a557957 · a557957
2 parents 14cc154 + 421f8d9
commit a557957
Showing 1 changed file with 5 additions and 2 deletions.
diff --git a/crates/compiler/builtins/roc/Str.roc b/crates/compiler/builtins/roc/Str.roc
@@ -880,8 +880,11 @@ walkUtf8WithIndexHelp = \string, state, step, index, length ->
 ## state for each byte.
 ##
 ## ```
-## result = walkUtf8 "hello, world!" "" (\state, byte -> state ++ String.fromCodePoint byte)
-## expect result == Ok "hello, world!"
+## sumOfUtf8Bytes =
+##     Str.walkUtf8 "Hello, World!" 0 \total, byte ->
+##         total + byte
+##
+## expect sumOfUtf8Bytes == 105
 ## ```
 walkUtf8 : Str, state, (state, U8 -> state) -> state
 walkUtf8 = \str, initial, step ->