Browse Source

Doc config Load

Brendan Abolivier 6 years ago
parent
commit
24358cae4f
Signed by: Brendan Abolivier <contact@brendanabolivier.com> GPG key ID: 8EF1500759F70623
1 changed files with 3 additions and 0 deletions
  1. 3
    0
      src/config/config.go

+ 3
- 0
src/config/config.go View File

@@ -46,6 +46,9 @@ type WebhookSettings struct {
46 46
 	Secret    string `yaml:"secret"`
47 47
 }
48 48
 
49
+// Load opens a given configuration file and parses it into an instance of the
50
+// Config structure.
51
+// Returns an error if there was an issue whith reading or parsing the file.
49 52
 func Load(filename string) (cfg *Config, err error) {
50 53
 	rawCfg, err := ioutil.ReadFile(filename)
51 54
 	if err != nil {