From 0b5528b3e04d2142b81dc22383ea6bbe0f1dbe1c Mon Sep 17 00:00:00 2001
From: Finn Bear <finnbearlabs@gmail.com>
Date: Tue, 29 Dec 2020 20:22:49 -0800
Subject: [PATCH] Fix documentation.

---
 moderation.go | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/moderation.go b/moderation.go
index c3ff8ba..54d49a1 100644
--- a/moderation.go
+++ b/moderation.go
@@ -45,7 +45,7 @@ var replacements = [...]string{
 
 var removeAccentsTransform = transform.Chain(norm.NFD, runes.Remove(runes.In(unicode.Mn)), norm.NFC)
 
-// Analyze analyzes a given phrase for moderation purposes
+// IsInappropriate returns whether a phrase contains enough inappropriate words to meet or exceed InappropriateThreshold
 func IsInappropriate(text string) bool {
 	buf := make([]byte, 0, len(text))
 	_, n, _ := transform.Append(removeAccentsTransform, buf, []byte(text))