Skip to content

Commit

Permalink
Improve documentation on some variable and type.
Browse files Browse the repository at this point in the history
  • Loading branch information
cedric-appdirect committed Oct 24, 2023
1 parent fdcd0a0 commit 9927b42
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion graceful.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
"github.com/gin-gonic/gin"
)

// Graceful is a wrapper around a gin.Engine that provides graceful shutdown
// Graceful is a wrapper around a [gin.Engine] that provides graceful shutdown
type Graceful struct {
*gin.Engine

Expand All @@ -23,7 +23,10 @@ type Graceful struct {
cleanup []cleanup
}

// ErrAlreadyStarted is returned when trying to start a router that has already been started
var ErrAlreadyStarted = errors.New("already started router")

// ErrNotStarted is returned when trying to stop a router that has not been started
var ErrNotStarted = errors.New("router not started")

type listenAndServe func() error
Expand Down

0 comments on commit 9927b42

Please sign in to comment.