doc: document WithDatastore option

Stebalien · aschmahmann · vyzo · commit 415b3531024d · 2021-04-23T20:09:03.000+03:00
Co-authored-by: Adin Schmahmann &lt;adin.schmahmann@gmail.com&gt;
diff --git a/namesys.go b/namesys.go
@@ -78,7 +78,7 @@ func WithDNSResolver(rslv madns.BasicResolver) Option {
 	}
 }
 
-// WithDatastore is an option that supplies a datastore to use instead of an in-memory map datastore.
+// WithDatastore is an option that supplies a datastore to use instead of an in-memory map datastore. The datastore is used to store published IPNS records and make them available for querying.
 func WithDatastore(ds ds.Datastore) Option {
 	return func(ns *mpns) error {
 		ns.ds = ds

Original file line number	Diff line number	Diff line change
`@@ -78,7 +78,7 @@ func WithDNSResolver(rslv madns.BasicResolver) Option {`
`78`	`78`	`}`
`79`	`79`	`}`
`80`	`80`
`81`		`-// WithDatastore is an option that supplies a datastore to use instead of an in-memory map datastore.`
	`81`	`+// WithDatastore is an option that supplies a datastore to use instead of an in-memory map datastore. The datastore is used to store published IPNS records and make them available for querying.`
`82`	`82`	`func WithDatastore(ds ds.Datastore) Option {`
`83`	`83`	`return func(ns *mpns) error {`
`84`	`84`	`ns.ds = ds`