summaryrefslogtreecommitdiffhomepage
path: root/modules.go
diff options
context:
space:
mode:
authorMatthew Holt <[email protected]>2020-04-17 12:03:57 -0600
committerMatthew Holt <[email protected]>2020-04-17 12:03:57 -0600
commitf980170909e20194aa963469cba0b47a55d5b02e (patch)
tree41d3a6f525b6ed946b627e02ea3739f401782744 /modules.go
parent6963a72a63bf2905e85be170d54371da4b3c5b8b (diff)
downloadcaddy-f980170909e20194aa963469cba0b47a55d5b02e.tar.gz
caddy-f980170909e20194aa963469cba0b47a55d5b02e.zip
doc: Improve comment
Diffstat (limited to 'modules.go')
-rw-r--r--modules.go7
1 files changed, 6 insertions, 1 deletions
diff --git a/modules.go b/modules.go
index 584a2984b..0f4a563be 100644
--- a/modules.go
+++ b/modules.go
@@ -65,7 +65,12 @@ type ModuleInfo struct {
// New returns a pointer to a new, empty
// instance of the module's type. This
- // function must not have any side-effects.
+ // method must not have any side-effects,
+ // and no other initialization should
+ // occur within it. Any initialization
+ // of the returned value should be done
+ // in a Provision() method (see the
+ // Provisioner interface).
New func() Module
}