From 79baf42e1e315b3ca064cda6991fa99ac24986e1 Mon Sep 17 00:00:00 2001 From: Hector Sanjuan Date: Tue, 6 Feb 2018 19:17:59 +0100 Subject: [PATCH] Golint: improve io.Find documentation per @stebalien's comment License: MIT Signed-off-by: Hector Sanjuan --- unixfs/io/dirbuilder.go | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/unixfs/io/dirbuilder.go b/unixfs/io/dirbuilder.go index f2dee053c..616617dee 100644 --- a/unixfs/io/dirbuilder.go +++ b/unixfs/io/dirbuilder.go @@ -162,9 +162,8 @@ func (d *Directory) Links(ctx context.Context) ([]*ipld.Link, error) { return d.shard.EnumLinks(ctx) } -// Find returns the ipld.Node with the given name, if it is contained in this -// directory. Find only searches in the most inmediate links, and not -// recursively in the tree. +// Find returns the root node of the file named 'name' within this directory. +// In the case of HAMT-directories, it will traverse the tree. func (d *Directory) Find(ctx context.Context, name string) (ipld.Node, error) { if d.shard == nil { lnk, err := d.dirnode.GetNodeLink(name)