Merge pull request #624 from influxdata/js-godoc-query-package

docs(query): add package docs for the packages in the query package

query/ast/ast.go

@@ -1,3 +1,4 @@
+// Package ast declares the types used to represent the syntax tree for Flux source code.
 package ast
 
 import (

query/ast/asttest/cmpgen/main.go

@@ -1,3 +1,4 @@
+// cmpgen generates comparison options for the asttest package.
 package main
 
 import (

query/ast/asttest/doc.go

@@ -0,0 +1,2 @@
+// Package asttest implements utilities for testing the abstract syntax tree.
+package asttest

query/csv/result.go

@@ -1,3 +1,4 @@
+// Package csv contains the csv result encoders and decoders.
 package csv
 
 import (

query/execute/executetest/doc.go

@@ -0,0 +1,2 @@
+// Package executetest contains utilities for testing the query execution phase.
+package executetest

query/execute/executor.go

@@ -1,3 +1,4 @@
+// Package execute contains the implementation of the execution phase in the query engine.
 package execute
 
 import (

query/functions/functions.go

@@ -0,0 +1,2 @@
+// Package functions contains the implementations for the builtin functions.
+package functions

query/functions/storage/storage.go

@@ -1,3 +1,4 @@
+// Package storage implements reading from a storage engine into a table as a data source.
 package storage
 
 import (

query/influxql/spectests/doc.go

@@ -0,0 +1,2 @@
+// Package spectests the influxql transpiler specification tests.
+package spectests

query/influxql/transpiler.go

@@ -1,3 +1,4 @@
+// Package influxql implements the transpiler for executing influxql queries in the 2.0 query engine.
 package influxql
 
 import (

query/interpreter/doc.go

@@ -1,2 +1,2 @@
-// Package interpreter provides an implementation of an Flux interpreter.
+// Package interpreter provides the implementation of the Flux interpreter.
 package interpreter

query/mock/doc.go

@@ -0,0 +1,2 @@
+// Package mock contains mock implementations of the query package interfaces for testing.
+package mock

query/options/task.go

@@ -1,3 +1,4 @@
+// Package options implements flux options.
 package options
 
 import (

query/plan/doc.go

@@ -0,0 +1,2 @@
+// Package plan implements the flux query planner to plan execution of a query spec.
+package plan

query/plan/plantest/doc.go

@@ -0,0 +1,2 @@
+// Package plantest contains utilities for testing the query planning phase.
+package plantest

query/promql/promql.go

@@ -1,3 +1,4 @@
+// Package promql implements a promql parser to build flux query specifications from promql.
 package promql
 
 import (

query/query.go

@@ -1,3 +1,4 @@
+// Package query contains the InfluxDB 2.0 query engine.
 package query
 
 import (

query/querytest/doc.go

@@ -0,0 +1,2 @@
+// Package querytest contains utilities for testing the query end-to-end.
+package querytest

query/repl/repl.go

@@ -1,19 +1,18 @@
+// Package repl implements the read-eval-print-loop for the command line flux query console.
 package repl
 
 import (
 	"context"
 	"fmt"
+	"io/ioutil"
 	"os"
 	"os/signal"
+	"path/filepath"
 	"sort"
 	"strings"
 	"sync"
 	"syscall"
 
-	"io/ioutil"
-
-	"path/filepath"
-
 	prompt "github.com/c-bata/go-prompt"
 	"github.com/influxdata/platform"
 	"github.com/influxdata/platform/query"

query/semantic/semantictest/doc.go

@@ -0,0 +1,2 @@
+// Package semantictest contains utilities for testing the semantic package.
+package semantictest

query/values/values.go

@@ -1,3 +1,4 @@
+// Package values declares the flux data types and implements them.
 package values
 
 import (