diff options
| author | Karthik Nayak <knayak@gitlab.com> | 2023-01-03 17:59:27 +0300 |
|---|---|---|
| committer | Karthik Nayak <knayak@gitlab.com> | 2023-01-09 18:35:50 +0300 |
| commit | 09a9d59ea52e76592acb1c011c3104b2075cdec6 (patch) | |
| tree | e45c19c1bf4b2f2566afc57cfb95800d4cf2de1e | |
| parent | 47eb4b80511c3d6001807f617b22ca3aa4de8b58 (diff) | |
quarantine: Clarify documentation around cleanup
| -rw-r--r-- | internal/git/quarantine/quarantine.go | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/internal/git/quarantine/quarantine.go b/internal/git/quarantine/quarantine.go index fa8d7e617..41afb8e1f 100644 --- a/internal/git/quarantine/quarantine.go +++ b/internal/git/quarantine/quarantine.go @@ -29,8 +29,8 @@ type Dir struct { locator storage.Locator } -// New creates a new quarantine directory and returns both the directory as well as its cleanup -// function. +// New creates a new quarantine directory and returns the directory. The repository is cleaned +// up when the user invokes the Migrate() functionality on the Dir. func New(ctx context.Context, repo *gitalypb.Repository, locator storage.Locator) (*Dir, error) { repoPath, err := locator.GetPath(repo) if err != nil { |