improved documentation

master
Charles Iliya Krempeaux 2022-07-18 22:12:14 -07:00
parent 50d87b31bb
commit c2b6e0a0b0
2 changed files with 23 additions and 1 deletions

View File

@ -7,6 +7,28 @@ import (
// ReadRune reads a single UTF-8 encoded Unicode character from an io.Reader, // 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. // and returns the Unicode character (as a Go rune) and the number of bytes read.
// //
// If reader is nil then ReaderRune will return an error that matches utf8.NilReaderComplainer.
//
// Example
//
// Here is an example usage of ReadRune:
//
// r, n, err := utf8.ReadRune(reader)
// if nil != err {
//
// switch err.(type) {
// case utf8.NilReaderComplainer:
// //@TODO
// case utf8.InvalidUTF8Complainer:
// //@TODO
// default:
// //TODO
// }
//
// }
//
// Number Of Bytes
//
// Note that a single UTF-8 encoded Unicode character could be more than one byte. // 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. // For example, the Unicode "≡" (IDENTICAL TO) character gets encoded using 3 bytes under UTF-8.

View File

@ -6,7 +6,7 @@ import (
// WriteRune writes a single UTF-8 encoded Unicode character and returns the number of bytes written. // WriteRune writes a single UTF-8 encoded Unicode character and returns the number of bytes written.
// //
// If writer is nil then WriteRune will return an error that matches utf8.WriteRune. // If writer is nil then WriteRune will return an error that matches utf8.NilWriterComplainer.
// //
// Example // Example
// //