Add doc comments

buildkite · Aug 28, 2023 · 99df9c1 · 99df9c1
1 parent 6216756
commit 99df9c1
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/internal/file/is_opened.go b/internal/file/is_opened.go
@@ -8,6 +8,7 @@ import (
 	"github.com/buildkite/agent/v3/internal/job/shell"
 )
 
+// IsOpened returns true if the file at the given path is opened by the current process.
 func IsOpened(l shell.Logger, debug bool, path string) (bool, error) {
 	fdEntries, err := os.ReadDir("/dev/fd")
 	if err != nil {

diff --git a/internal/file/opened_by.go b/internal/file/opened_by.go
@@ -18,6 +18,7 @@ var (
 	numeric        = regexp.MustCompile("^[0-9]+$")
 )
 
+// OpenedBy attempts to find the executable that opened the given file.
 func OpenedBy(l shell.Logger, debug bool, path string) (string, error) {
 	pidEntries, err := os.ReadDir("/proc")
 	if err != nil {