diff options
author | Matthew Holt <mholt@users.noreply.github.com> | 2019-12-23 12:45:35 -0700 |
---|---|---|
committer | Matthew Holt <mholt@users.noreply.github.com> | 2019-12-23 12:45:35 -0700 |
commit | 95ed603de79c66ff76bfe7e42986a2fc8c7a1fa4 (patch) | |
tree | 1a788b8eba98f0c2e69e5816bac9c7cc09aca96f /modules/caddyhttp/subroute.go | |
parent | cbb405f6aaee046c9de9ffb4f07ca824d9eedeb1 (diff) |
Improve godocs all around
These will be used in the new automated documentation system
Diffstat (limited to 'modules/caddyhttp/subroute.go')
-rw-r--r-- | modules/caddyhttp/subroute.go | 6 |
1 files changed, 5 insertions, 1 deletions
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"` } |