diff --git a/.github/README.md b/.github/README.md index 363c694..6bead6b 100644 --- a/.github/README.md +++ b/.github/README.md @@ -84,7 +84,7 @@ func LoadConfig(ctx context.Context, path string) (*Config, error) { - [INI Files](https://pkg.go.dev/github.com/zpatrick/cfg#INIFile) - [TOML Files](https://pkg.go.dev/github.com/zpatrick/cfg#TOMLFile) -For **YAML** files, please see the [local](https://github.com/zpatrick/cfg/blob/main/example_yaml_test.go) or [Godoc](https://pkg.go.dev/github.com/zpatrick/cfg#example-YAML) example. +For **YAML** files, please see the [example](https://github.com/zpatrick/cfg/blob/main/example_yaml_test.go). # Validation A setting may specify a [Validator](https://pkg.go.dev/github.com/zpatrick/cfg#Validator) which will check whether or not a provided value is valid. diff --git a/example_yaml_test.go b/example_yaml_test.go index 7be515c..52698e3 100644 --- a/example_yaml_test.go +++ b/example_yaml_test.go @@ -23,7 +23,7 @@ type yamlFile struct { } `yaml:"server"` } -func Example_YAML() { +func ExampleYAML() { const data = ` timeout: 5s server: