Merge pull request #7309 from ipfs/fix/plugin-docs

doc(plugin): document plugin config
ipfs · May 21, 2020 · e0aa23d · e0aa23d
2 parents 4b10fdb + 0cc3d7a
commit e0aa23d
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/plugin/plugin.go b/plugin/plugin.go
@@ -5,7 +5,12 @@ type Environment struct {
 	// Path to the IPFS repo.
 	Repo string
 
-	// The plugin's config, if specified.
+	// The plugin's config, if specified in the
+	// Plugins.Plugins["plugin-name"].Config field of the user's go-ipfs
+	// config. See docs/plugins.md for details.
+	//
+	// This is an arbitrary JSON-like object unmarshaled into an interface{}
+	// according to https://golang.org/pkg/encoding/json/#Unmarshal.
 	Config interface{}
 }