From d0009206b457b55495e0cdd39e622b9315be08eb Mon Sep 17 00:00:00 2001 From: Travis Turner Date: Tue, 6 Mar 2018 12:42:29 -0600 Subject: [PATCH] add comments to exported methods. remove debugging test. --- cluster.go | 6 ++++-- holder_test.go | 31 ------------------------------- 2 files changed, 4 insertions(+), 33 deletions(-) diff --git a/cluster.go b/cluster.go index ed5318917..a2d537b11 100644 --- a/cluster.go +++ b/cluster.go @@ -74,7 +74,7 @@ func (n Node) String() string { return fmt.Sprintf("Node: %s", n.ID) } -// EncodeNodes converts a into its internal representation. +// EncodeNodes converts a slice of Nodes into its internal representation. func EncodeNodes(a []*Node) []*internal.Node { other := make([]*internal.Node, len(a)) for i := range a { @@ -83,7 +83,7 @@ func EncodeNodes(a []*Node) []*internal.Node { return other } -// EncodeNode converts n into its internal representation. +// EncodeNode converts a Node into its internal representation. func EncodeNode(n *Node) *internal.Node { return &internal.Node{ ID: n.ID, @@ -91,6 +91,7 @@ func EncodeNode(n *Node) *internal.Node { } } +// DecodeNodes converts a proto message into a slice of Nodes. func DecodeNodes(a []*internal.Node) []*Node { if len(a) == 0 { return nil @@ -102,6 +103,7 @@ func DecodeNodes(a []*internal.Node) []*Node { return other } +// DecodeNode converts a proto message into a Node. func DecodeNode(node *internal.Node) *Node { return &Node{ ID: node.ID, diff --git a/holder_test.go b/holder_test.go index 3422fe081..5a06a9272 100644 --- a/holder_test.go +++ b/holder_test.go @@ -338,37 +338,6 @@ func TestHolder_HasData(t *testing.T) { }) } -/* -func TestHolder_Schema(t *testing.T) { - t.Run("Schema", func(t *testing.T) { - h := test.MustOpenHolder() - defer h.Close() - - if idx, err := h.CreateIndex("i", pilosa.IndexOptions{}); err != nil { - t.Fatal(err) - } else if frame, err := idx.CreateFrame("f", pilosa.FrameOptions{}); err != nil { - t.Fatal(err) - } else if view, err := frame.CreateViewIfNotExists(pilosa.ViewStandard); err != nil { - t.Fatal(err) - } else if _, err := view.SetBit(0, 0); err != nil { - t.Fatal(err) - } else if err := h.Holder.Close(); err != nil { - t.Fatal(err) - } else if err := os.Chmod(filepath.Join(h.Path, "i", "f", "views", "standard", "fragments", "0"), 0000); err != nil { - t.Fatal(err) - } - fmt.Printf("%v\n", h.Schema()) - defer os.Chmod(filepath.Join(h.Path, "i", "f", "views", "standard", "fragments", "0"), 0666) - - if err := h.Reopen(); err == nil || !strings.Contains(err.Error(), "permission denied") { - t.Fatalf("unexpected error: %s", err) - } - - t.Fatalf("STOPPER") - }) -} -*/ - // Ensure holder can delete an index and its underlying files. func TestHolder_DeleteIndex(t *testing.T) { hldr := test.MustOpenHolder()