Skip to content

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
ktong committed Feb 4, 2024
1 parent 0c982fe commit 393c325
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions provider/appconfig/appconfig.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
// AppConfig loads configuration from AWS AppConfig with the given application, environment, profile
// and returns a nested map[string]any that is parsed with the given unmarshal function.
//
// The unmarshal function must be able to unmarshal the file content into a map[string]any.
// For example, with the default json.Unmarshal, the file is parsed as JSON.
// The unmarshal function must be able to unmarshal the configuration into a map[string]any.
// For example, with the default json.Unmarshal, the configuration is parsed as JSON.
package appconfig

import (
Expand Down
6 changes: 3 additions & 3 deletions provider/appconfig/option.go
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,8 @@ func WithPollInterval(pollInterval time.Duration) Option {
}
}

// WithUnmarshal provides the function used to parses the configuration file.
// The unmarshal function must be able to unmarshal the file content into a map[string]any.
// WithUnmarshal provides the function used to parses the configuration.
// The unmarshal function must be able to unmarshal the configuration into a map[string]any.
//
// The default function is json.Unmarshal.
func WithUnmarshal(unmarshal func([]byte, any) error) Option {
Expand All @@ -50,7 +50,7 @@ func WithLogHandler(handler slog.Handler) Option {
}

type (
// Option configures the a File with specific options.
// Option configures the a AppConfig with specific options.
Option func(options *options)
options struct {
AppConfig
Expand Down

0 comments on commit 393c325

Please sign in to comment.