From ddb208590cf5edb488036e64f1b52b62545c0f90 Mon Sep 17 00:00:00 2001 From: Ana Krivokapic Date: Tue, 25 Oct 2022 12:52:02 +0200 Subject: [PATCH] Update comment --- files/paths.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/files/paths.go b/files/paths.go index c930de2..dbd3bf4 100644 --- a/files/paths.go +++ b/files/paths.go @@ -68,7 +68,8 @@ func Grep(regex *regexp.Regexp, glob string) (bool, error) { return false, nil } -// Return the relative path you would have to take to get from basePath to path +// GetPathRelativeTo returns the relative path you would have to take to get from basePath to path. If either path +// or basePath are symbolic links, they will be evaluated before the relative path between them is calculated. func GetPathRelativeTo(path string, basePath string) (string, error) { if path == "" { path = "."