diff options
Diffstat (limited to 'docs/content/en/functions/fmt/Warnf.md')
-rw-r--r-- | docs/content/en/functions/fmt/Warnf.md | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/docs/content/en/functions/fmt/Warnf.md b/docs/content/en/functions/fmt/Warnf.md new file mode 100644 index 000000000..f4fa22474 --- /dev/null +++ b/docs/content/en/functions/fmt/Warnf.md @@ -0,0 +1,38 @@ +--- +title: fmt.Warnf +description: Log a WARNING from a template. +categories: [] +keywords: [] +action: + aliases: [warnf] + related: + - functions/fmt/Errorf + - functions/fmt/Erroridf + - functions/fmt/Warnidf + returnType: string + signatures: ['fmt.Warnf FORMAT [INPUT]'] +aliases: [/functions/warnf] +--- + +{{% include "functions/fmt/_common/fmt-layout.md" %}} + +The `warnf` function evaluates the format string, then prints the result to the WARNING log. Hugo prints each unique message once to avoid flooding the log with duplicate warnings. + +```go-html-template +{{ warnf "The %q shortcode was unable to find %s. See %s" .Name $file .Position }} +``` + +Use the [`warnidf`] function to allow optional suppression of specific warnings. + +To prevent suppression of duplicate messages when using `warnf` for debugging, make each message unique with the [`math.Counter`] function. For example: + + +```go-html-template +{{ range site.RegularPages }} + {{ .Section | warnf "%#[2]v [%[1]d]" math.Counter }} +{{ end }} +``` + +[`math.Counter`]: /functions/math/counter/ + +[`warnidf`]: /functions/fmt/warnidf/ |