mirror of https://github.com/gohugoio/hugo
35 lines
1.0 KiB
Markdown
35 lines
1.0 KiB
Markdown
---
|
|
title: fmt.Warnf
|
|
description: Log a WARNING from a template.
|
|
categories: []
|
|
keywords: []
|
|
params:
|
|
functions_and_methods:
|
|
aliases: [warnf]
|
|
returnType: string
|
|
signatures: ['fmt.Warnf FORMAT [INPUT]']
|
|
aliases: [/functions/warnf]
|
|
---
|
|
|
|
{{% include "/_common/functions/fmt/format-string.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/
|