docs

chanced · Aug 31, 2022 · 09a180d · 09a180d
1 parent 162d00e
commit 09a180d
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -143,7 +143,7 @@ Finally, if you are so inclined, you can create your own `caps.Converter`. This
 could be as simple as implementing the single `Convert` method, calling
 `caps.DefaultConverter.Convert`, and then modifying the result.
 
-### Support for special case unicode (e.g. Turkish, Azeri)
+## Support for special case unicode (e.g. Turkish, Azeri)
 
 caps supports Turkish and Azeri through the `token.Caser` interface. It is
 satisfied by `unicode.TurkishCase` and `unicode.AzeriCase`. `token.TurkishCaser`

diff --git a/index/index.go b/index/index.go
@@ -1,3 +1,4 @@
+// Package index contains a trie index used by Converter to lookup Replacements.
 package index
 
 import (
@@ -21,7 +22,7 @@ func (ir IndexedReplacement) HasValue() bool {
 	return !ir.IsEmpty()
 }
 
-// Index is a double trie (forward and backward indexed) of token.Token.
+// Index is a trie index used by Converter to lookup Replacements.
 type Index struct {
 	value          IndexedReplacement
 	nodes          map[rune]*Index

diff --git a/text/text.go b/text/text.go
@@ -1,3 +1,7 @@
+// Package text contains a single Text type with functions from caps and strings
+// as methods.
+//
+// All methods return new values and do not mutate the existing Text.
 package text
 
 import (