Add TODO notes

Author: sfischer13

interval.go

@@ -12,12 +12,14 @@ var reRangeS = regexp.MustCompile(`^(\d*)$`)
 var reRangeM = regexp.MustCompile(`^(\d*):(\d*)$`)
 var reRangeL = regexp.MustCompile(`^(\d*):(\d*):(\d*)$`)
 
+// Interval TODO
 type Interval struct {
 	Low  int64
 	High int64
 	Step int64
 }
 
+// NewInterval TODO
 func NewInterval(low, high, step string) Interval {
 	if low == "" {
 		low = "1"
@@ -44,10 +46,12 @@ func NewInterval(low, high, step string) Interval {
 	}
 }
 
+// Contains TODO
 func (r *Interval) Contains(i int64) bool {
 	return (i >= r.Low) && (i <= r.High) && (((i - r.Low) % r.Step) == 0)
 }
 
+// String2Intervals TODO
 func String2Intervals(s string) []Interval {
 	if reRanges.MatchString(s) {
 		result := []Interval{}
@@ -75,6 +79,7 @@ func String2Intervals(s string) []Interval {
 	return nil
 }
 
+// Intervals2Func TODO
 func Intervals2Func(rs []Interval) func(int64) bool {
 	return func(i int64) bool {
 		result := false

list.go

@@ -1,22 +1,27 @@
 package datautils
 
+// List TODO
 type List struct {
 	Elements []string
 }
 
+// NewList TODO
 func NewList() List {
 	list := List{}
 	return list
 }
 
+// Add TODO
 func (l *List) Add(element string) {
 	l.Elements = append(l.Elements, element)
 }
 
+// Clear TODO
 func (l *List) Clear() {
 	l.Elements = []string{}
 }
 
+// IsEmpty TODO
 func (l *List) IsEmpty() bool {
 	return len(l.Elements) == 0
 }

main.go

@@ -26,6 +26,7 @@ func processStdin(c *cli.Context, process func(string) error) error {
 	return err
 }
 
+// DefaultApp TODO
 func DefaultApp(version, date, goVersion string) *cli.App {
 	app := cli.NewApp()
 	dateTime := ParseRFCDate(date).Format("2006-01-02")

math.go

@@ -1,5 +1,6 @@
 package datautils
 
+// Max TODO
 func Max(x, y int64) int64 {
 	if x > y {
 		return x

pair.go

@@ -2,32 +2,38 @@ package datautils
 
 import "sort"
 
+// Pair TODO
 type Pair struct {
 	Key   string
 	Value int64
 }
 
+// Pairs TODO
 type Pairs []Pair
 
+// ReverseKeys TODO
 func (ps Pairs) ReverseKeys() {
 	sort.SliceStable(ps, func(i, j int) bool {
 		return ps[i].Key > ps[j].Key
 	})
 
 }
 
+// ReverseValues TODO
 func (ps Pairs) ReverseValues() {
 	sort.SliceStable(ps, func(i, j int) bool {
 		return ps[i].Value > ps[j].Value
 	})
 }
 
+// SortKeys TODO
 func (ps Pairs) SortKeys() {
 	sort.SliceStable(ps, func(i, j int) bool {
 		return ps[i].Key < ps[j].Key
 	})
 }
 
+// SortValues TODO
 func (ps Pairs) SortValues() {
 	sort.SliceStable(ps, func(i, j int) bool {
 		return ps[i].Value < ps[j].Value

pipe.go

@@ -4,6 +4,7 @@ import "bufio"
 import "fmt"
 import "os"
 
+// StdinSource TODO
 func StdinSource() <-chan string {
 	out := make(chan string)
 	go func() {
@@ -17,12 +18,14 @@ func StdinSource() <-chan string {
 	return out
 }
 
+// StdoutSink TODO
 func StdoutSink(src <-chan string) {
 	for s := range src {
 		fmt.Println(s)
 	}
 }
 
+// TransformPipe TODO
 func TransformPipe(src <-chan string, transform func(string) string) <-chan string {
 	out := make(chan string)
 	go func() {

string.go

@@ -2,10 +2,12 @@ package datautils
 
 import "strings"
 
+// IsWhite TODO
 func IsWhite(s string) bool {
 	return len(strings.TrimSpace(s)) == 0
 }
 
+// IsNotWhite TODO
 func IsNotWhite(s string) bool {
 	return !IsWhite(s)
 }