Skip to content

Commit 47bcf65

Browse files
authored
style: edit package comments (#41)
1 parent 7d272f1 commit 47bcf65

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed

errors/errors.go

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
// Package errors implements error interface.
2+
//
23
// HTTPError has first class support in Kid and is used for returning proper responses when an error happens.
34
package errors
45

@@ -38,7 +39,7 @@ func (e *HTTPError) WithError(err error) *HTTPError {
3839
return e
3940
}
4041

41-
// WithMessage sets a new message for the error.
42+
// WithMessage sets the error message.
4243
//
4344
// This message will be sent in response in Kid's default error handler. So it should of a type which can be converted to JSON.
4445
func (e *HTTPError) WithMessage(message any) *HTTPError {

html_renderer/html.go

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
// Package htmlrenderer provides an interface and its implementations for rendering HTML pages.
12
package htmlrenderer
23

34
import (

serializer/serializer.go

+4
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
// Package serializer provides an interface to read from request body or write to response body.
2+
// Can be used for reading/writing JSON, XML, MessagePack, etc.
3+
//
4+
// Currently the supported ones are JSON and XML.
15
package serializer
26

37
import (

0 commit comments

Comments
 (0)