summaryrefslogtreecommitdiff
path: root/locale/en-US/libs/@lua/utf8.lni
diff options
context:
space:
mode:
Diffstat (limited to 'locale/en-US/libs/@lua/utf8.lni')
-rw-r--r--locale/en-US/libs/@lua/utf8.lni2
1 files changed, 2 insertions, 0 deletions
diff --git a/locale/en-US/libs/@lua/utf8.lni b/locale/en-US/libs/@lua/utf8.lni
index c7ab9bf3..c0fb3c27 100644
--- a/locale/en-US/libs/@lua/utf8.lni
+++ b/locale/en-US/libs/@lua/utf8.lni
@@ -7,11 +7,13 @@ description = 'The pattern which matches exactly one UTF-8 byte sequence, assumi
[codes]
description = [[
--------
+Returns values so that the construction
```lua
for p, c in utf8.codes(s) do
body
end
```
+will iterate over all UTF-8 characters in string s, with p being the position (in bytes) and c the code point of each character. It raises an error if it meets any invalid byte sequence.
]]
["codes Lua 5.4"]