Skip to content

chore: fix typos in httperror.go #2958

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.

Sign up for GitHub

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

Open
tisonkun wants to merge 1 commit into
base: master
Choose a base branch
from
+9 −9
Open

chore: fix typos in httperror.go #2958

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions httperror.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import (
"net/http"
)

// Following errors can produce HTTP status code by implementing HTTPStatusCoder interface
// The following errors can produce HTTP status code by implementing HTTPStatusCoder interface
var (
ErrBadRequest = &httpError{http.StatusBadRequest} // 400
ErrUnauthorized = &httpError{http.StatusUnauthorized} // 401
Expand All @@ -25,7 +25,7 @@ var (
ErrServiceUnavailable = &httpError{http.StatusServiceUnavailable} // 503
)

// Following errors fall into 500 (InternalServerError) category
// The following errors fall into 500 (InternalServerError) category
var (
ErrValidatorNotRegistered = errors.New("validator not registered")
ErrRendererNotRegistered = errors.New("renderer not registered")
Expand All @@ -35,13 +35,13 @@ var (
ErrInvalidListenerNetwork = errors.New("invalid listener network")
)

// HTTPStatusCoder is interface that errors can implement to produce status code for HTTP response
// HTTPStatusCoder is an interface that errors can implement to produce status code for HTTP response
type HTTPStatusCoder interface {
StatusCode() int
}

// StatusCode returns status code from error if it implements HTTPStatusCoder interface.
// If error does not implement the interface it returns 0.
// StatusCode returns status code from err if it implements HTTPStatusCoder interface.
// If err does not implement the interface, it returns 0.
func StatusCode(err error) int {
var sc HTTPStatusCoder
if errors.As(err, &sc) {
Expand Down Expand Up @@ -95,7 +95,7 @@ func ResolveResponseStatus(rw http.ResponseWriter, err error) (resp *Response, s
return resp, status
}

// NewHTTPError creates new instance of HTTPError
// NewHTTPError creates a new instance of HTTPError
func NewHTTPError(code int, message string) *HTTPError {
return &HTTPError{
Code: code,
Expand All @@ -116,7 +116,7 @@ func (he *HTTPError) StatusCode() int {
return he.Code
}

// Error makes it compatible with `error` interface.
// Error makes it compatible with the ` error ` interface.
func (he *HTTPError) Error() string {
msg := he.Message
if msg == "" {
Expand All @@ -128,8 +128,8 @@ func (he *HTTPError) Error() string {
return fmt.Sprintf("code=%d, message=%v, err=%v", he.Code, msg, he.err.Error())
}

// Wrap eturns new HTTPError with given errors wrapped inside
func (he HTTPError) Wrap(err error) error {
// Wrap returns a new HTTPError with given errors wrapped inside
func (he *HTTPError) Wrap(err error) error {
Copy link
Copy Markdown
Author

@tisonkun tisonkun Apr 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a non-trivial change but it keeps all receivers as pointer receivers. Or else my linter would report:

Struct HTTPError has methods on both value and pointer receivers. Such usage is not recommended by the Go Documentation.

return &HTTPError{
Code: he.Code,
Message: he.Message,
Expand Down