From 95ed603de79c66ff76bfe7e42986a2fc8c7a1fa4 Mon Sep 17 00:00:00 2001 From: Matthew Holt Date: Mon, 23 Dec 2019 12:45:35 -0700 Subject: Improve godocs all around These will be used in the new automated documentation system --- modules/caddyhttp/subroute.go | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'modules/caddyhttp/subroute.go') diff --git a/modules/caddyhttp/subroute.go b/modules/caddyhttp/subroute.go index a60eaf7..13453a5 100644 --- a/modules/caddyhttp/subroute.go +++ b/modules/caddyhttp/subroute.go @@ -37,7 +37,11 @@ func init() { // is only returned to the entry point at the server if there is an // additional error returned from the errors routes. type Subroute struct { - Routes RouteList `json:"routes,omitempty"` + // The primary list of routes to compile and execute. + Routes RouteList `json:"routes,omitempty"` + + // If the primary routes return an error, error handling + // can be promoted to this configuration instead. Errors *HTTPErrorConfig `json:"errors,omitempty"` } -- cgit v1.2.3