- update docs

Author: rocketlaunchr-cto

exports/sql.go

@@ -1,5 +1,7 @@
 // Copyright 2018-20 PJ Engineering and Business Solutions Pty. Ltd. All rights reserved.
 
+// Package exports provides functionality to save the data contained in a DataFrame into another format.
+// It provides inverse functionality to the imports package.
 package exports
 
 import (

forecast/algs/hw/holt_winters.go

@@ -1,5 +1,6 @@
 // Copyright 2018-20 PJ Engineering and Business Solutions Pty. Ltd. All rights reserved.
 
+// Package hw implements the Holt-Winters forecasting algorithm.
 package hw
 
 import (

forecast/algs/ses/ses.go

@@ -1,5 +1,6 @@
 // Copyright 2018-20 PJ Engineering and Business Solutions Pty. Ltd. All rights reserved.
 
+// Package ses implements the simple exponential smooting forecasting algorithm.
 package ses
 
 import (

forecast/forecast.go

@@ -1,5 +1,6 @@
 // Copyright 2018-20 PJ Engineering and Business Solutions Pty. Ltd. All rights reserved.
 
+// Package forecast provides an interface for custom forecasting algorithms.
 package forecast
 
 import (

forecast/interpolation/interpolate.go

@@ -1,5 +1,6 @@
 // Copyright 2018-20 PJ Engineering and Business Solutions Pty. Ltd. All rights reserved.
 
+// Package interpolation implements various algorithms to fill in missing values in a Series or DataFrame.
 package interpolation
 
 import (

imports/common.go

@@ -1,5 +1,7 @@
 // Copyright 2018-20 PJ Engineering and Business Solutions Pty. Ltd. All rights reserved.
 
+// Package imports provides functionality to read data contained in another format to populate a DataFrame.
+// It provides inverse functionality to the exports package.
 package imports
 
 import (

math/funcs/funcs.go

@@ -1,3 +1,6 @@
+// Copyright 2018-20 PJ Engineering and Business Solutions Pty. Ltd. All rights reserved.
+
+// Package funcs provides functionality to apply mathematical functions to DataFrames.
 package funcs
 
 import (
@@ -109,7 +112,7 @@ func (p pfs) pf(row int) (*formula.Formula, error) {
 return nil, &dataframe.RowError{row, ErrUndefined}
 }
 
-// Evaluate applies a PiecewiseFuncDefn to a particular series in a DataFrame.
+// Evaluate applies a PiecewiseFuncDefn to a particular Series in a DataFrame.
 //
 // Example:
 //

math/funcs/funcs_test.go

@@ -1,3 +1,5 @@
+// Copyright 2018-20 PJ Engineering and Business Solutions Pty. Ltd. All rights reserved.
+
 package funcs
 
 import (

math/matrix/matrix.go

@@ -1,3 +1,7 @@
+// Copyright 2018-20 PJ Engineering and Business Solutions Pty. Ltd. All rights reserved.
+
+// Package matrix can be used to wrap a DataFrame such that it implements the Matrix
+// interface found in various external packages such as gonum.
 package matrix
 
 import (

math/matrix/matrix_test.go

@@ -1,3 +1,5 @@
+// Copyright 2018-20 PJ Engineering and Business Solutions Pty. Ltd. All rights reserved.
+
 package matrix
 
 import (