add godoc for NumFD() (#6)

fortio · Mar 4, 2023 · 11259a2 · 11259a2
1 parent 31b1bd7
commit 11259a2
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/num_fd.go b/num_fd.go
@@ -43,6 +43,8 @@ func countDir(dir string) int {
 	return len(names) - 1 // for the dir we just opened
 }
 
+// NumFD returns the number of open file descriptors (or -1 on error).
+// On windows it returns the number of handles.
 func NumFD() int {
 	switch runtime.GOOS {
 	case "windows":

diff --git a/scli.go b/scli.go
@@ -9,6 +9,8 @@
 // Configure using the [cli] package variables (at minimum [MinArgs] unless your
 // binary only accepts flags), setup additional [flag] before calling
 // [ServerMain].
+// It also includes [NumFD] utility function to cross platform get the number
+// of open file descriptors (handles on windows) held by your go process.
 package scli // import "fortio.org/scli"
 
 import (