clarify return value of cpu.Percent()

8 years ago · facb241c12
parent f18f7dcbae
commit facb241c12
1 changed files with 3 additions and 2 deletions
--- a/cpu/cpu.go
+++ b/cpu/cpu.go
@ -132,6 +132,7 @@ func calculateAllBusy(t1, t2 []TimesStat) ([]float64, error) {

 // Percent calculates the percentage of cpu used either per CPU or combined.
 // If an interval of 0 is given it will compare the current cpu times against the last call.
+// Returns one value per cpu, or a single value if percpu is set to false.
 func Percent(interval time.Duration, percpu bool) ([]float64, error) {
 	if interval <= 0 {
 		return percentUsedFromLastCall(percpu)