Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Jacob Oaks <[email protected]>
  • Loading branch information
abhinav and JacobOaks authored Feb 20, 2024
1 parent e5fb0a0 commit 8633a29
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions app.go
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ func (og optionGroup) String() string {
}

// StartTimeout changes the application's start timeout.
// This controls the total time that all OnStart hooks have to complete.
// This controls the total time that all [OnStart] hooks have to complete.
// If the timeout is exceeded, the application will fail to start.
//
// Defaults to [DefaultTimeout].
Expand All @@ -135,7 +135,7 @@ func (t startTimeoutOption) String() string {
}

// StopTimeout changes the application's stop timeout.
// This controls the total time that all OnStop hooks have to complete.
// This controls the total time that all [OnStop] hooks have to complete.
// If the timeout is exceeded, the application will exit early.
//
// Defaults to [DefaultTimeout].
Expand Down Expand Up @@ -180,7 +180,7 @@ func (o recoverFromPanicsOption) String() string {
return "fx.RecoverFromPanics()"
}

// WithLogger specifies the logger used by Fx to log its own events
// WithLogger specifies the [fxevent.Logger] used by Fx to log its own events
// (e.g. a constructor was provided, a function was invoked, etc.).
//
// The argument to this is a constructor with one of the following return
Expand All @@ -199,7 +199,7 @@ func (o recoverFromPanicsOption) String() string {
// If specified, Fx will construct the logger and log all its events to the
// specified logger.
//
// If Fx fails to build the logger, it will fall back to
// If Fx fails to build the logger, or no logger is specified, it will fall back to
// [fxevent.ConsoleLogger] configured to write to stderr.
func WithLogger(constructor interface{}) Option {
return withLoggerOption{
Expand Down Expand Up @@ -227,7 +227,7 @@ func (l withLoggerOption) String() string {
// Printer is the interface required by Fx's logging backend. It's implemented
// by most loggers, including the one bundled with the standard library.
//
// Note, this will be deprecate in a future release.
// Note, this will be deprecated in a future release.
// Prefer to use [fxevent.Logger] instead.
type Printer interface {
Printf(string, ...interface{})
Expand Down

0 comments on commit 8633a29

Please sign in to comment.