Add DocBlock to WatchConfig (#1467)

* Add DocBlock to WatchConfig Added a small description of the WatchConfig(). So that you can understand in the ide why you could use it. * Update viper.go * update viper.go Signed-off-by: Mark Sagi-Kazar <[email protected]> Signed-off-by: Mark Sagi-Kazar <[email protected]> Co-authored-by: Márk Sági-Kazár <[email protected]> Co-authored-by: Mark Sagi-Kazar <[email protected]>
spf13 · Jan 19, 2023 · 5182412 · 5182412
1 parent 0755477
commit 5182412
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/viper.go b/viper.go
@@ -421,13 +421,18 @@ var SupportedExts = []string{"json", "toml", "yaml", "yml", "properties", "props
 // SupportedRemoteProviders are universally supported remote providers.
 var SupportedRemoteProviders = []string{"etcd", "etcd3", "consul", "firestore"}
 
+// OnConfigChange sets the event handler that is called when a config file changes.
 func OnConfigChange(run func(in fsnotify.Event)) { v.OnConfigChange(run) }
+
+// OnConfigChange sets the event handler that is called when a config file changes.
 func (v *Viper) OnConfigChange(run func(in fsnotify.Event)) {
 	v.onConfigChange = run
 }
 
+// WatchConfig starts watching a config file for changes.
 func WatchConfig() { v.WatchConfig() }
 
+// WatchConfig starts watching a config file for changes.
 func (v *Viper) WatchConfig() {
 	initWG := sync.WaitGroup{}
 	initWG.Add(1)