Document more of how Strip() works

writeas · Feb 26, 2018 · 6e12ec3 · 6e12ec3
1 parent f212b21
commit 6e12ec3
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/strip.go b/strip.go
@@ -33,6 +33,9 @@ var (
 )
 
 // Strip returns the given string sans any Markdown.
+// Where necessary, elements are replaced with their best textual forms, so
+// for example, hyperlinks are stripped of their URL and become only the link
+// text, and images lose their URL and become only the alt text.
 func Strip(s string) string {
 	res := s
 	res = listLeadersReg.ReplaceAllString(res, "$1")