diff options
| author | Patrick Steinhardt <psteinhardt@gitlab.com> | 2022-02-24 12:29:37 +0300 |
|---|---|---|
| committer | Patrick Steinhardt <psteinhardt@gitlab.com> | 2022-03-01 14:34:52 +0300 |
| commit | b59babab5083c9441aa75ad0970b39a536f4493c (patch) | |
| tree | 299057c45a4b850b08936fa01364c2e634815411 | |
| parent | d481c75006ab618855500ea36021fa2cbf66da38 (diff) | |
operations: Document the UserSquash implementation
Add a short documentation snippet to UserSquash so that we can get rid
of the previous linting exception.
| -rw-r--r-- | internal/gitaly/service/operations/squash.go | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/internal/gitaly/service/operations/squash.go b/internal/gitaly/service/operations/squash.go index 7b070848e..9e778f55d 100644 --- a/internal/gitaly/service/operations/squash.go +++ b/internal/gitaly/service/operations/squash.go @@ -19,7 +19,8 @@ const ( ambiguousArgumentFmt = "fatal: ambiguous argument '%s...%s': unknown revision or path not in the working tree.\nUse '--' to separate paths from revisions, like this:\n'git <command> [<revision>...] -- [<file>...]'\n" ) -//nolint: revive,stylecheck // This is unintentionally missing documentation. +// UserSquash collapses a range of commits identified via a start and end revision into a single +// commit whose single parent is the start revision. func (s *Server) UserSquash(ctx context.Context, req *gitalypb.UserSquashRequest) (*gitalypb.UserSquashResponse, error) { if err := validateUserSquashRequest(req); err != nil { return nil, helper.ErrInvalidArgumentf("UserSquash: %v", err) |