Document Path function

1 files changed, 2 insertions, 0 deletions

diff --git a/proxy.go b/proxy.go
index 79e9e68..1375e1d 100644
--- a/proxy.go
+++ b/proxy.go
@@ -26,6 +26,8 @@ var playerNameChars = regexp.MustCompile("^[a-zA-Z0-9-_]+$")
 var proxyDir string
 var proxyDirOnce sync.Once
 
+// Path prepends the directory the executable is in to the given path.
+// It does not follow symlinks.
 func Path(path ...string) string {
 	proxyDirOnce.Do(func() {
 		executable, err := os.Executable()