From 02845bc9fdc3e9189d44f3bd30e8609cd59c97dd Mon Sep 17 00:00:00 2001
From: Matthew Holt <mholt@users.noreply.github.com>
Date: Fri, 24 Apr 2020 21:05:09 -0600
Subject: docs: Improve template documentation slightly; use const, not literal

---
 modules/caddyhttp/templates/templates.go | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'modules/caddyhttp/templates')

diff --git a/modules/caddyhttp/templates/templates.go b/modules/caddyhttp/templates/templates.go
index d67b35b..f5df9be 100644
--- a/modules/caddyhttp/templates/templates.go
+++ b/modules/caddyhttp/templates/templates.go
@@ -113,6 +113,19 @@ func init() {
 // {{.RemoteIP}}
 // ```
 //
+// ##### `.Req`
+//
+// Accesses the current HTTP request, which has various fields, including:
+//
+//    - `.Method` - the method
+//    - `.URL` - the URL, which in turn has component fields (Scheme, Host, Path, etc.)
+//    - `.Header` - the header fields
+//    - `.Host` - the Host or :authority header of the request
+//
+// ```
+// {{.Req.Header.Get "User-Agent"}}
+// ```
+//
 // ##### `.RespHeader.Add`
 //
 // Adds a header field to the HTTP response.
-- 
cgit v1.2.3