From 9db25e5b381fbd6350583b857e74ecaffe355819 Mon Sep 17 00:00:00 2001 From: Tatsuya Kaneko Date: Sun, 26 Jun 2022 22:32:16 +0900 Subject: [PATCH] middleware: fix broken comment on go doc (#735) Example code is broken on go doc. https://pkg.go.dev/github.com/go-chi/chi/middleware#Logger --- middleware/logger.go | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/middleware/logger.go b/middleware/logger.go index 66edc3dd..98250d82 100644 --- a/middleware/logger.go +++ b/middleware/logger.go @@ -30,14 +30,11 @@ var ( // http logger with structured logging support. // // IMPORTANT NOTE: Logger should go before any other middleware that may change -// the response, such as `middleware.Recoverer`. Example: -// -// ```go -// r := chi.NewRouter() -// r.Use(middleware.Logger) // <--<< Logger should come before Recoverer -// r.Use(middleware.Recoverer) -// r.Get("/", handler) -// ``` +// the response, such as middleware.Recoverer. Example: +// r := chi.NewRouter() +// r.Use(middleware.Logger) // <--<< Logger should come before Recoverer +// r.Use(middleware.Recoverer) +// r.Get("/", handler) func Logger(next http.Handler) http.Handler { return DefaultLogger(next) }