- update docs

teastburn · Aug 11, 2020 · eaa3a4e · eaa3a4e
1 parent 6f7b598
commit eaa3a4e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -243,7 +243,7 @@ sx := dataframe.NewSeriesFloat64("x", nil, dataframe.Float64Range(1, float64(res
 sy := dataframe.NewSeriesFloat64("y", &dataframe.SeriesInit{Size: res})
 df := dataframe.NewDataFrame(sx, sy)
 
-fn := funcs.RegularFunc("sin((2*𝜋*x)/24)")
+fn := funcs.RegFunc("sin((2*𝜋*x)/24)")
 funcs.PiecewiseFunc(ctx, df, fn, 1)
 ```
 

diff --git a/math/funcs/funcs.go b/math/funcs/funcs.go
@@ -87,8 +87,8 @@ type SubFuncDefn struct {
 	Domain *dataframe.Range
 }
 
-// RegularFunc represents a non-piecewise function that is not constrained by a domain.
-func RegularFunc(fn string) []SubFuncDefn {
+// RegFunc represents a regular function not split into different domain segments.
+func RegFunc(fn string) []SubFuncDefn {
 	return []SubFuncDefn{{Fn: fn}}
 }
 
@@ -113,7 +113,7 @@ func (p pfs) pf(row int) (*formula.Formula, error) {
 //
 // Example:
 //
-//  fn := funcs.RegularFunc("sin((2*𝜋*x)/24)")
+//  fn := funcs.RegFunc("sin((2*𝜋*x)/24)")
 //  funcs.PiecewiseFunc(ctx, df, fn, 1)
 //
 func PiecewiseFunc(ctx context.Context, df *dataframe.DataFrame, fn PiecewiseFuncDefn, col interface{}, opts ...PiecewiseFuncOptions) error {