builtin: document the rune.length_in_bytes method (#13826)

vlang · Mar 25, 2022 · ea4410c · ea4410c
1 parent 347db75
commit ea4410c
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/vlib/builtin/rune.v b/vlib/builtin/rune.v
@@ -61,6 +61,8 @@ pub fn (c rune) bytes() []byte {
 	return res
 }
 
+// length_in_bytes returns the number of bytes needed to store the code point.
+// Returns -1 if the data is not a valid code point.
 pub fn (c rune) length_in_bytes() int {
 	code := u32(c)
 	if code <= 0x7F {