nit: document Node

ac092e5f · Steven Allen · 09a574cf · ac092e5f
Commit ac092e5f authored Jun 22, 2017 by Steven Allen
Hide whitespace changes
Inline Side-by-side

Showing with 4 additions and 0 deletions

format.go format.go +4 -0

No files found.
--- a/format.go
+++ b/format.go
@@ -19,6 +19,10 @@ type Resolver interface {
 	Tree(path string, depth int) []string
 }

+// Node is the base interface all IPLD nodes must implement.
+//
+// Nodes are **Immutable** and all methods defined on the interface are
+// **Thread Safe**.
 type Node interface {
 	blocks.Block
 	Resolver