diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2021-06-07 16:36:48 +0200 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2021-06-07 19:11:03 +0200 |
commit | f55d2f43769053b80b419a690554e747dc5dcede (patch) | |
tree | f8c5bdc95df123f2abb04d66b87af4bf9237f086 /docs | |
parent | 282f1aa3db9f6420fdd360e46db1ffadd5b083a1 (diff) |
tpl/fmt: Add erroridf template func
Fixes #8613
Diffstat (limited to 'docs')
-rw-r--r-- | docs/content/en/functions/errorf.md | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/content/en/functions/errorf.md b/docs/content/en/functions/errorf.md index 450e92679..a20ad4f44 100644 --- a/docs/content/en/functions/errorf.md +++ b/docs/content/en/functions/errorf.md @@ -31,3 +31,22 @@ Both functions return an empty string, so the messages are only printed to the c ``` Note that `errorf` and `warnf` support all the formatting verbs of the [fmt](https://golang.org/pkg/fmt/) package. + +## Suppress errors + +Some times 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 arument. + + +`` +{{ 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 config: +ignoreErrors = ["my-custom-error"] +``` |