add tests, make golint pass #29
Conversation
| } | ||
|
|
||
| // DefaultBlockDecoder is a safeBlockDecoder with no decoders registered |
There was a problem hiding this comment.
safeBlockDecoder isn't exported so I wouldn't mention it by here. I'd just say "DefaultBlockDecoder is the block decoder used by Decode" and maybe mention that (a) it's threadsafe and (b) users should register block decoders with it.
| @@ -9,6 +9,7 @@ import ( | |||
| cid "github.com/ipfs/go-cid" | |||
| ) | |||
|
|
|||
| // Resolver is the interface that details paths a node contains | |||
There was a problem hiding this comment.
Resolver is more something that can be resolved through than something that "details" (although I'm planning on reworking these interfaces in the near future).
| @@ -19,6 +20,7 @@ type Resolver interface { | |||
| Tree(path string, depth int) []string | |||
| } | |||
|
|
|||
| // Node is an object in a Merkle DAG graph | |||
There was a problem hiding this comment.
- DAG graph is redundant.
- We usually say merkledag as one word.
| @@ -40,7 +42,9 @@ type Node interface { | |||
| Size() (uint64, error) | |||
| } | |||
|
|
|||
| // NodeGetter is the interface that wraps the basic get method | |||
There was a problem hiding this comment.
NodeGetter is really just a read-only DAG service. I'd take a look at #8, it makes a lot of this clearer. Actually, I recommend making the pull request against that branch as I'll likely merge that first.
| @@ -56,6 +60,11 @@ type Link struct { | |||
| Cid *cid.Cid | |||
| } | |||
|
|
|||
| // GetNode returns the MDAG Node that this link points to | |||
|
Oooooh ok makes sense. Well at least I still learned a thing :) |
|
Also, documentation is always welcome. |
might as well write tests while learning stuff. I've also added comments to make golint happy, feel free to let me know if any of those are inaccurate.
cc @Stebalien