clarify the relation between StoreIdentityCIDs and SetFullyIndexed

I had to read the code to remind myself if this was the case. Document it, for the sake of other godoc readers.
ipld · Sep 27, 2021 · 999f74f · 999f74f
1 parent f35d88c
commit 999f74f
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/v2/options.go b/v2/options.go
@@ -86,6 +86,9 @@ func UseIndexCodec(c multicodec.Code) Option {
 
 // StoreIdentityCIDs sets whether to persist sections that are referenced by
 // CIDs with multihash.IDENTITY digest.
+// When writing CAR files with this option,
+// Characteristics.IsFullyIndexed will be set.
+//
 // This option is disabled by default.
 func StoreIdentityCIDs(b bool) Option {
 	return func(o *Options) {