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

doc(plugin): document plugin config
This commit is contained in:
Steven Allen 2020-05-20 18:04:08 -07:00 committed by GitHub
commit e0aa23d4a6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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{}
}