added more docs

2018-07-02 11:28:12 -07:00 · 2018-07-02 11:28:12 -07:00 · 9acec1ea30
parent 50a81feeba
commit 9acec1ea30
1 changed files with 24 additions and 0 deletions
--- a/len.go
+++ b/len.go
@ -1,6 +1,30 @@
 package utf8s

 // Len returns the number of bytes in a UTF-8 encoding of this Unicode code point.
+//
+// Example
+//
+//	length := utf8s.Len('A')
+//
+//	// length == 1
+//
+// Example
+//
+//	length := utf8s.Len('r')
+//
+//	// length == 1
+//
+// Example
+//
+//	length := utf8s.Len('¡')
+//
+//	// length == 2
+//
+// Example
+//
+//	length := utf8s.Len('۵')
+//
+//	// length == 2
 func Len(r rune) int {

 	switch {