Update comment

infraredgirl · infraredgirl · commit ddb208590cf5 · 2022-10-25T12:52:02.000+02:00
diff --git 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 = "."

Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,8 @@ func Grep(regex *regexp.Regexp, glob string) (bool, error) {`
`68`	`68`	`return false, nil`
`69`	`69`	`}`
`70`	`70`
`71`		`-// Return the relative path you would have to take to get from basePath to path`
	`71`	`+// GetPathRelativeTo returns the relative path you would have to take to get from basePath to path. If either path`
	`72`	`+// or basePath are symbolic links, they will be evaluated before the relative path between them is calculated.`
`72`	`73`	`func GetPathRelativeTo(path string, basePath string) (string, error) {`
`73`	`74`	`if path == "" {`
`74`	`75`	`path = "."`