summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/errorf.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/errorf.md')
-rw-r--r--docs/content/en/functions/errorf.md45
1 files changed, 0 insertions, 45 deletions
diff --git a/docs/content/en/functions/errorf.md b/docs/content/en/functions/errorf.md
deleted file mode 100644
index 8caaf0554..000000000
--- a/docs/content/en/functions/errorf.md
+++ /dev/null
@@ -1,45 +0,0 @@
----
-title: errorf and warnf
-description: Log ERROR or WARNING from the templates.
-categories: [functions]
-menu:
- docs:
- parent: functions
-keywords: [strings, log, error]
-signature: ["errorf FORMAT INPUT"]
-relatedfuncs: [printf]
----
-
-`errorf` or `warnf` will evaluate a format string, then output the result to the ERROR or WARNING log (and only once per error message to avoid flooding the log).
-
-Any ERROR will also cause the build to fail (the `hugo` command will `exit -1`).
-
-Both functions return an empty string, so the messages are only printed to the console.
-
-```go-html-template
-{{ errorf "Failed to handle page %q" .Path }}
-```
-
-```go-html-template
-{{ warnf "You should update the shortcodes in %q" .Path }}
-```
-
-Note that `errorf`, `erroridf`, and `warnf` support all the formatting verbs of the [fmt](https://pkg.go.dev/fmt) package.
-
-## Suppress errors
-
-Sometimes it may make sense to let the user suppress an ERROR and make the build succeed.
-
-You can do this by using the `erroridf` function. This functions takes an error ID as the first argument.
-
-```go-html-template
-{{ erroridf "my-custom-error" "You should consider fixing this." }}
-```
-
-This will produce:
-
-```
-ERROR 2021/06/07 17:47:38 You should consider fixing this.
-If you feel that this should not be logged as an ERROR, you can ignore it by adding this to your site configuration:
-ignoreErrors = ["my-custom-error"]
-```