Fix timeout middleware docs (fixes #1816) (#1836)

labstack · Apr 6, 2021 · 10d8c53 · 10d8c53
1 parent ae4665c
commit 10d8c53
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/middleware/timeout.go b/middleware/timeout.go
@@ -42,8 +42,8 @@ var (
 	}
 )
 
-// Timeout returns a middleware which recovers from panics anywhere in the chain
-// and handles the control to the centralized HTTPErrorHandler.
+// Timeout returns a middleware which returns error (503 Service Unavailable error) to client immediately when handler
+// call runs for longer than its time limit. NB: timeout does not stop handler execution.
 func Timeout() echo.MiddlewareFunc {
 	return TimeoutWithConfig(DefaultTimeoutConfig)
 }