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/encode/brotli | |
| parent | cbb405f6aaee046c9de9ffb4f07ca824d9eedeb1 (diff) | |
Improve godocs all around
These will be used in the new automated documentation system
Diffstat (limited to 'modules/caddyhttp/encode/brotli')
| -rw-r--r-- | modules/caddyhttp/encode/brotli/brotli.go | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/modules/caddyhttp/encode/brotli/brotli.go b/modules/caddyhttp/encode/brotli/brotli.go index 52bb205..fababd3 100644 --- a/modules/caddyhttp/encode/brotli/brotli.go +++ b/modules/caddyhttp/encode/brotli/brotli.go @@ -29,7 +29,9 @@ func init() { } // Brotli can create brotli encoders. Note that brotli -// is not known for great encoding performance. +// is not known for great encoding performance, and +// its use during requests is discouraged; instead, +// pre-compress the content instead. type Brotli struct { Quality *int `json:"quality,omitempty"` } |