From 6f5e22e764283262ae8c6519bb030766db0fd35b Mon Sep 17 00:00:00 2001 From: Runxi Yu Date: Sun, 6 Apr 2025 09:58:02 +0800 Subject: Add more documentation comments --- forged/internal/git2c/cmd_index.go | 2 ++ 1 file changed, 2 insertions(+) (limited to 'forged/internal/git2c/cmd_index.go') diff --git a/forged/internal/git2c/cmd_index.go b/forged/internal/git2c/cmd_index.go index a705a63..8862b2c 100644 --- a/forged/internal/git2c/cmd_index.go +++ b/forged/internal/git2c/cmd_index.go @@ -10,6 +10,8 @@ import ( "io" ) +// CmdIndex requests a repository index from git2d and returns the list of commits +// and the contents of a README file if available. func (c *Client) CmdIndex(repoPath string) ([]Commit, *FilenameContents, error) { if err := c.writer.WriteData([]byte(repoPath)); err != nil { return nil, nil, fmt.Errorf("sending repo path failed: %w", err) -- cgit v1.2.3