From 4e0aa2bdc2d70a95a14ef91e97238b49f6831cf7 Mon Sep 17 00:00:00 2001 From: Charles Iliya Krempeaux Date: Mon, 2 Jul 2018 01:36:39 -0700 Subject: [PATCH] improved docs --- readrune.go | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/readrune.go b/readrune.go index afc2aa4..391f53c 100644 --- a/readrune.go +++ b/readrune.go @@ -6,6 +6,10 @@ import ( // ReadRune reads a single UTF-8 encoded Unicode character from an io.Reader, // and returns the Unicode character (as a Go rune) and the number of bytes read. +// +// Note that a single UTF-8 encoded Unicode character could be more than one byte. +// +// For example, the Unicode "≡" (IDENTICAL TO) character gets encoded using 3 bytes under UTF-8. func ReadRune(reader io.Reader) (rune, int, error) { if nil == reader { return 0, 0, errNilReader