From 2edc0ee299abccc61c984bb8e4100c1851f8b1d6 Mon Sep 17 00:00:00 2001 From: Christopher Allen Lane Date: Sun, 28 Aug 2022 06:54:29 -0400 Subject: [PATCH] chore: add a comment Add a small comment regarding a tricky edge-case in `gitdir.go`. --- internal/repo/gitdir.go | 1 + 1 file changed, 1 insertion(+) diff --git a/internal/repo/gitdir.go b/internal/repo/gitdir.go index b532827..06a7f23 100644 --- a/internal/repo/gitdir.go +++ b/internal/repo/gitdir.go @@ -60,6 +60,7 @@ func GitDir(path string) (bool, error) { 2. A cheatpath is a repository 3. A cheatpath is a repository, and contains a `.git*` file 4. A cheatpath is a submodule + 5. A cheatpath is a hidden directory Care must be taken to support the above on both Unix and Windows systems, which have different directory separators and line-endings.