Skip to content

Commit b265b72

Browse files
committed
Extend config#FromYAMLFile() documentation
1 parent 734edd3 commit b265b72

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

config/config.go

+3
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,9 @@ var ErrInvalidArgument = stderrors.New("invalid argument")
1919
// FromYAMLFile parses the given YAML file and stores the result
2020
// in the value pointed to by v. If v is nil or not a pointer,
2121
// FromYAMLFile returns an [ErrInvalidArgument] error.
22+
// It is possible to define default values via the struct tag `default`.
23+
// The function also validates the configuration using the Validate method
24+
// of the provided [Validator] interface.
2225
//
2326
// Example usage:
2427
//

0 commit comments

Comments
 (0)