aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorWes Morgan <wesmorgan@icloud.com>2020-04-07 07:59:17 -0600
committerWes Morgan <wesmorgan@icloud.com>2020-04-07 07:59:17 -0600
commit4d4e2b1fe291d8ab5cc844a03f2a03e073a87a8c (patch)
tree8cf8d207950c5fde01a238b39a7f8ce0e68ba8e9
parent8df0dec7e676c1281c46834614c68fb09697bf45 (diff)
downloadgo-git-4d4e2b1fe291d8ab5cc844a03f2a03e073a87a8c.tar.gz
Add advanced usage note to config example
-rw-r--r--_examples/config/main.go4
1 files changed, 4 insertions, 0 deletions
diff --git a/_examples/config/main.go b/_examples/config/main.go
index 22dc447..5fb8fba 100644
--- a/_examples/config/main.go
+++ b/_examples/config/main.go
@@ -45,6 +45,10 @@ func main() {
Info("origin remote: %+v", cfg.Remotes["origin"])
+ // NOTE: The examples below show advanced usage of the config.Merged system, which should
+ // only be used as a last resort if the basic data defined on the Config struct don't
+ // suffice for what you're trying to do.
+
// Set local custom config param
cfg.Merged.LocalConfig().AddOption("custom", format.NoSubsection, "name", "Local Name")