diff options
Diffstat (limited to 'docs/content/en/functions/fmt/Warnidf.md')
-rw-r--r-- | docs/content/en/functions/fmt/Warnidf.md | 43 |
1 files changed, 43 insertions, 0 deletions
diff --git a/docs/content/en/functions/fmt/Warnidf.md b/docs/content/en/functions/fmt/Warnidf.md new file mode 100644 index 000000000..cbe75816e --- /dev/null +++ b/docs/content/en/functions/fmt/Warnidf.md @@ -0,0 +1,43 @@ +--- +title: fmt.Warnidf +description: Log a suppressible WARNING from a template. +categories: [] +keywords: [] +action: + aliases: [warnidf] + related: + - functions/fmt/Errorf + - functions/fmt/Erroridf + - functions/fmt/Warnf + returnType: string + signatures: ['fmt.Warnidf ID FORMAT [INPUT]'] +aliases: [/functions/warnidf] +--- + +{{< new-in 0.123.0 >}} + +{{% include "functions/fmt/_common/fmt-layout.md" %}} + +The `warnidf` function evaluates the format string, then prints the result to the WARNING log. Unlike the [`warnf`] function, you may suppress warnings logged by the `warnidf` function by adding the message ID to the `ignoreLogs` array in your site configuration. + +This template code: + +```go-html-template +{{ warnidf "warning-42" "You should consider fixing this." }} +``` + +Produces this console log: + +```text +WARN You should consider fixing this. +You can suppress this warning by adding the following to your site configuration: +ignoreLogs = ['warning-42'] +``` + +To suppress this message: + +{{< code-toggle file=hugo >}} +ignoreLogs = ["warning-42"] +{{< /code-toggle >}} + +[`warnf`]: /functions/fmt/warnf/ |