templates: Document httpError function (#4972)

* added the httpError function into the document * Update templates.go * Update templates.go * Fix gofmt Co-authored-by: Matt Holt <mholt@users.noreply.github.com>
caddyserver · Sep 2, 2022 · 66959d9 · 66959d9
1 parent f2a7e7c
commit 66959d9
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/modules/caddyhttp/templates/templates.go b/modules/caddyhttp/templates/templates.go
@@ -189,6 +189,14 @@ func init() {
 // {{.RespHeader.Set "Field-Name" "val"}}
 // ```
 //
+// ##### `httpError`
+//
+// Returns an error with the given status code to the HTTP handler chain.
+//
+// ```
+// {{if not (fileExists $includedFile)}}{{httpError 404}}{{end}}
+// ```
+//
 // ##### `splitFrontMatter`
 //
 // Splits front matter out from the body. Front matter is metadata that appears at the very beginning of a file or string. Front matter can be in YAML, TOML, or JSON formats: