Some doc updates to make golint happier.
diff --git a/bytes.go b/bytes.go
index 78453bf..c44d4f8 100644
--- a/bytes.go
+++ b/bytes.go
@@ -81,22 +81,22 @@
}
-// String up an SI size.
+// Bytes produces a human readable representation of an SI size.
// Bytes(82854982) -> 83MB
func Bytes(s uint64) string {
sizes := []string{"B", "KB", "MB", "GB", "TB", "PB", "EB"}
return humanateBytes(uint64(s), 1000, sizes)
}
-// String an IEC size.
+// IBytes produces a human readable representation of an IEC size.
// IBytes(82854982) -> 79MiB
func IBytes(s uint64) string {
sizes := []string{"B", "KiB", "MiB", "GiB", "TiB", "PiB", "EiB"}
return humanateBytes(uint64(s), 1024, sizes)
}
-// Parse a string representation of bytes into the number of bytes it
-// represents
+// ParseBytes parses a string representation of bytes into the number
+// of bytes it represents.
// ParseBytes("42MB") -> 42000000, nil
// ParseBytes("42mib") -> 44040192, nil
func ParseBytes(s string) (uint64, error) {
diff --git a/comma.go b/comma.go
index 26666e1..d032bfb 100644
--- a/comma.go
+++ b/comma.go
@@ -5,7 +5,9 @@
"strings"
)
-// Place commas after every three orders of magnitude.
+// Comma produces a string form of the given number in base 10 with
+// commas after every three orders of magnitude.
+// e.g. Comma(834142) -> 834,142
func Comma(v int64) string {
sign := ""
if v < 0 {
diff --git a/humanize.go b/humanize.go
index e88ca64..74142c2 100644
--- a/humanize.go
+++ b/humanize.go
@@ -1,5 +1,5 @@
/*
-Units for humans.
+Package humanize converts boring ugly numbers to human-friendly strings.
Durations can be turned into strings such as "3 days ago", numbers
representing sizes like 82854982 into useful strings like, "83MB" or
diff --git a/ordinals.go b/ordinals.go
index ecc911f..32b05ed 100644
--- a/ordinals.go
+++ b/ordinals.go
@@ -2,6 +2,8 @@
import "strconv"
+// Ordinal gives you the input number in a rank/ordinal format.
+// Ordinal(3) -> 3rd
func Ordinal(x int) string {
suffix := "th"
switch x % 10 {
diff --git a/times.go b/times.go
index 9a44674..ba0a9b8 100644
--- a/times.go
+++ b/times.go
@@ -15,7 +15,8 @@
Year = 12 * Month
)
-// Humanize the time.
+// Time formats a time into a relative string.
+// Time(someT) -> "3 weeks ago"
func Time(then time.Time) string {
now := time.Now()
