Skip to content

Wrong documentation on Timeout middleware #1816

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
3 tasks done
nevivurn opened this issue Mar 19, 2021 · 0 comments · Fixed by #1836
Closed
3 tasks done

Wrong documentation on Timeout middleware #1816

nevivurn opened this issue Mar 19, 2021 · 0 comments · Fixed by #1836

Comments

@nevivurn
Copy link

nevivurn commented Mar 19, 2021

Issue Description

The Timeout middleware godoc is wrong.

Checklist

  • Dependencies installed
  • No typos
  • Searched existing issues and docs

Expected behaviour

The godocs for the Timeout handler should describe what it does.

Actual behaviour

The godocs for the Timeout handler describe what the Recover middleware does.

Steps to reproduce

Working code to debug

$ go doc github.com/labstack/echo/v4/middleware.Timeout
package middleware // import "github.com/labstack/echo/v4/middleware"

func Timeout() echo.MiddlewareFunc
    Timeout returns a middleware which recovers from panics anywhere in the
    chain and handles the control to the centralized HTTPErrorHandler.

Version/commit

All commits since 67263b5, the first commit where the Timeout middleware function was introduced.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant