docs: add doc comment to parse

1 files changed, 5 insertions, 0 deletions

diff --git a/internal/links/find.go b/internal/links/find.go
index 4422826..44ba128 100644
--- a/internal/links/find.go
+++ b/internal/links/find.go
@@ -7,6 +7,11 @@ import (
 	"golang.org/x/net/html/atom"
 )
 
+// parse finds the links inside htmlInput and returns them as a slice
+// of strings, along with an error.
+//
+// The only possible error should be the one returned from calling
+// [html.Parse].
 func parse(htmlInput io.Reader) ([]string, error) {
 	doc, err := html.Parse(htmlInput)
 	if err != nil {