From 655b6b211ae6df0186abd740f248939f7ddeaec1 Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Mon, 31 Mar 2025 16:59:18 +0800 Subject: Add descriptive comments to most Go functions --- readme_to_html.go | 3 +++ 1 file changed, 3 insertions(+) (limited to 'readme_to_html.go') diff --git a/readme_to_html.go b/readme_to_html.go index 22f23a1..6d7bbbc 100644 --- a/readme_to_html.go +++ b/readme_to_html.go @@ -18,6 +18,8 @@ import ( var markdownConverter = goldmark.New(goldmark.WithExtensions(extension.GFM)) +// renderReadmeAtTree looks for README files in the supplied Git tree and +// returns its filename and rendered (and sanitized) HTML. func renderReadmeAtTree(tree *object.Tree) (readmeFilename string, readmeRenderedSafeHTML template.HTML) { var readmeRenderedUnsafe bytes.Buffer var readmeFile *object.File @@ -60,6 +62,7 @@ func renderReadmeAtTree(tree *object.Tree) (readmeFilename string, readmeRendere return "", "" } +// escapeHTML just escapes a string and wraps it in [template.HTML]. func escapeHTML(s string) template.HTML { return template.HTML(html.EscapeString(s)) //#nosec G203 } -- cgit v1.2.3