Skip to content
This repository has been archived by the owner on Jun 27, 2023. It is now read-only.

Commit

Permalink
fix doc
Browse files Browse the repository at this point in the history
  • Loading branch information
schomatis committed May 6, 2021
1 parent 51ba1e2 commit 53f4e21
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions io/directory.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import (
ipld "github.com/ipfs/go-ipld-format"
)

// UseHAMTSharding is a global option that allows switching to a HAMTDirectory
// HAMTShardingSize is a global option that allows switching to a HAMTDirectory
// when the BasicDirectory grows above the size (in bytes) signalled by this
// flag. The default size of 0 disables the option.
// The size is not the *exact* block size of the encoded BasicDirectory but just
Expand Down Expand Up @@ -108,10 +108,8 @@ func NewBasicDirectoryFromNode(dserv ipld.DAGService, node *mdag.ProtoNode) *Bas
return basicDir
}

// NewDirectory returns a Directory that can either be a HAMTDirectory if the
// UseHAMTSharding is set, or otherwise an UpgradeableDirectory containing a
// BasicDirectory that can be converted to a HAMTDirectory if the option is
// set in the future.
// NewDirectory returns a Directory implemented by UpgradeableDirectory
// containing a BasicDirectory that can be converted to a HAMTDirectory.
func NewDirectory(dserv ipld.DAGService) Directory {
return &UpgradeableDirectory{NewEmptyBasicDirectory(dserv)}
}
Expand Down

0 comments on commit 53f4e21

Please sign in to comment.