tofu: Update documentation

2021-02-23 09:21:21 -05:00
parent 964c17b99f
commit 89f0b3f94b
1 changed files with 2 additions and 1 deletions
--- a/tofu/tofu.go
+++ b/tofu/tofu.go
@@ -217,7 +217,8 @@ type PersistentHosts struct {
 	writer *HostWriter
 }

-// NewPersistentHosts returns a new persistent set of known hosts.
+// NewPersistentHosts returns a new persistent set of known hosts that stores
+// known hosts in hosts and writes new hosts to writer.
 func NewPersistentHosts(hosts *KnownHosts, writer *HostWriter) *PersistentHosts {
 	return &PersistentHosts{
 		hosts,