Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/gohugoio/hugo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2022-04-30 19:12:08 +0300
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2022-05-06 20:43:22 +0300
commit6eea32bd6bc8e7a7dd07a8cb6a8343ae2c74aba0 (patch)
treedc9b14069f5e983942ac53c6f5e6d8629a5c269e /tpl/transform
parenta6d545854a670356e93cd48e55de6e81233d68cb (diff)
tpl: Improve godoc
Diffstat (limited to 'tpl/transform')
-rw-r--r--tpl/transform/transform.go11
1 files changed, 6 insertions, 5 deletions
diff --git a/tpl/transform/transform.go b/tpl/transform/transform.go
index 2f62557de..7c0914378 100644
--- a/tpl/transform/transform.go
+++ b/tpl/transform/transform.go
@@ -90,9 +90,9 @@ func (ns *Namespace) HighlightCodeBlock(ctx hooks.CodeblockContext, opts ...any)
return hl.HighlightCodeBlock(ctx, optsv)
}
-// CanHighlight returns whether the given language is supported by the Chroma highlighter.
-func (ns *Namespace) CanHighlight(lang string) bool {
- return lexers.Get(lang) != nil
+// CanHighlight returns whether the given code language is supported by the Chroma highlighter.
+func (ns *Namespace) CanHighlight(language string) bool {
+ return lexers.Get(language) != nil
}
// HTMLEscape returns a copy of s with reserved HTML characters escaped.
@@ -105,7 +105,7 @@ func (ns *Namespace) HTMLEscape(s any) (string, error) {
return html.EscapeString(ss), nil
}
-// HTMLUnescape returns a copy of with HTML escape requences converted to plain
+// HTMLUnescape returns a copy of s with HTML escape requences converted to plain
// text.
func (ns *Namespace) HTMLUnescape(s any) (string, error) {
ss, err := cast.ToStringE(s)
@@ -116,7 +116,7 @@ func (ns *Namespace) HTMLUnescape(s any) (string, error) {
return html.UnescapeString(ss), nil
}
-// Markdownify renders a given input from Markdown to HTML.
+// Markdownify renders s from Markdown to HTML.
func (ns *Namespace) Markdownify(s any) (template.HTML, error) {
home := ns.deps.Site.Home()
@@ -144,6 +144,7 @@ func (ns *Namespace) Plainify(s any) (string, error) {
return helpers.StripHTML(ss), nil
}
+// For internal use.
func (ns *Namespace) Reset() {
ns.cache.Clear()
}