chore: tidy up function names and code comments (#69)

Author: unknwon

blame.go

@@ -9,8 +9,8 @@ type Blame struct {
 	lines []*Commit
 }
 
-// Line returns the commit by given line number (1-based).
-// It returns nil when no such line.
+// Line returns the commit by given line number (1-based). It returns nil when
+// no such line.
 func (b *Blame) Line(i int) *Commit {
 	if i <= 0 || len(b.lines) < i {
 		return nil

blob.go

@@ -14,8 +14,8 @@ type Blob struct {
 	*TreeEntry
 }
 
-// Bytes reads and returns the content of the blob all at once in bytes.
-// This can be very slow and memory consuming for huge content.
+// Bytes reads and returns the content of the blob all at once in bytes. This
+// can be very slow and memory consuming for huge content.
 func (b *Blob) Bytes() ([]byte, error) {
 	stdout := new(bytes.Buffer)
 	stderr := new(bytes.Buffer)
@@ -29,7 +29,8 @@ func (b *Blob) Bytes() ([]byte, error) {
 	return stdout.Bytes(), nil
 }
 
-// Pipeline reads the content of the blob and pipes stdout and stderr to supplied io.Writer.
+// Pipeline reads the content of the blob and pipes stdout and stderr to
+// supplied io.Writer.
 func (b *Blob) Pipeline(stdout, stderr io.Writer) error {
 	return NewCommand("show", b.id.String()).RunInDirPipeline(stdout, stderr, b.parent.repo.path)
 }

command.go

@@ -53,8 +53,8 @@ func (c *Command) AddEnvs(envs ...string) *Command {
 // DefaultTimeout is the default timeout duration for all commands.
 const DefaultTimeout = time.Minute
 
-// A limitDualWriter writes to W but limits the amount of data written to just N bytes.
-// On the other hand, it passes everything to w.
+// A limitDualWriter writes to W but limits the amount of data written to just N
+// bytes. On the other hand, it passes everything to w.
 type limitDualWriter struct {
 	W        io.Writer // underlying writer
 	N        int64     // max bytes remaining
@@ -81,10 +81,11 @@ func (w *limitDualWriter) Write(p []byte) (int, error) {
 	return w.w.Write(p)
 }
 
-// RunInDirPipelineWithTimeout executes the command in given directory and timeout duration.
-// It pipes stdout and stderr to supplied io.Writer. DefaultTimeout will be used if the timeout
-// duration is less than time.Nanosecond (i.e. less than or equal to 0).
-// It returns an ErrExecTimeout if the execution was timed out.
+// RunInDirPipelineWithTimeout executes the command in given directory and
+// timeout duration. It pipes stdout and stderr to supplied io.Writer.
+// DefaultTimeout will be used if the timeout duration is less than
+// time.Nanosecond (i.e. less than or equal to 0). It returns an ErrExecTimeout
+// if the execution was timed out.
 func (c *Command) RunInDirPipelineWithTimeout(timeout time.Duration, stdout, stderr io.Writer, dir string) (err error) {
 	if timeout < time.Nanosecond {
 		timeout = DefaultTimeout
@@ -148,14 +149,14 @@ func (c *Command) RunInDirPipelineWithTimeout(timeout time.Duration, stdout, std
 	}
 }
 
-// RunInDirPipeline executes the command in given directory and default timeout duration.
-// It pipes stdout and stderr to supplied io.Writer.
+// RunInDirPipeline executes the command in given directory and default timeout
+// duration. It pipes stdout and stderr to supplied io.Writer.
 func (c *Command) RunInDirPipeline(stdout, stderr io.Writer, dir string) error {
 	return c.RunInDirPipelineWithTimeout(DefaultTimeout, stdout, stderr, dir)
 }
 
-// RunInDirWithTimeout executes the command in given directory and timeout duration.
-// It returns stdout in []byte and error (combined with stderr).
+// RunInDirWithTimeout executes the command in given directory and timeout
+// duration. It returns stdout in []byte and error (combined with stderr).
 func (c *Command) RunInDirWithTimeout(timeout time.Duration, dir string) ([]byte, error) {
 	stdout := new(bytes.Buffer)
 	stderr := new(bytes.Buffer)
@@ -165,14 +166,14 @@ func (c *Command) RunInDirWithTimeout(timeout time.Duration, dir string) ([]byte
 	return stdout.Bytes(), nil
 }
 
-// RunInDir executes the command in given directory and default timeout duration.
-// It returns stdout and error (combined with stderr).
+// RunInDir executes the command in given directory and default timeout
+// duration. It returns stdout and error (combined with stderr).
 func (c *Command) RunInDir(dir string) ([]byte, error) {
 	return c.RunInDirWithTimeout(DefaultTimeout, dir)
 }
 
-// RunWithTimeout executes the command in working directory and given timeout duration.
-// It returns stdout in string and error (combined with stderr).
+// RunWithTimeout executes the command in working directory and given timeout
+// duration. It returns stdout in string and error (combined with stderr).
 func (c *Command) RunWithTimeout(timeout time.Duration) ([]byte, error) {
 	stdout, err := c.RunInDirWithTimeout(timeout, "")
 	if err != nil {

commit.go

@@ -37,8 +37,8 @@ func (c *Commit) Summary() string {
 	return strings.Split(c.Message, "\n")[0]
 }
 
-// ParentsCount returns number of parents of the commit.
-// It returns 0 if this is the root commit, otherwise returns 1, 2, etc.
+// ParentsCount returns number of parents of the commit. It returns 0 if this is
+// the root commit, otherwise returns 1, 2, etc.
 func (c *Commit) ParentsCount() int {
 	return len(c.parents)
 }
@@ -52,8 +52,8 @@ func (c *Commit) ParentID(n int) (*SHA1, error) {
 	return c.parents[n], nil
 }
 
-// Parent returns the n-th parent commit (0-based) of this commit.
-// It returns ErrRevisionNotExist if no such parent exists.
+// Parent returns the n-th parent commit (0-based) of this commit. It returns
+// ErrRevisionNotExist if no such parent exists.
 func (c *Commit) Parent(n int, opts ...CatFileCommitOptions) (*Commit, error) {
 	id, err := c.ParentID(n)
 	if err != nil {
@@ -68,14 +68,14 @@ func (c *Commit) CommitByPath(opts ...CommitByRevisionOptions) (*Commit, error)
 	return c.repo.CommitByRevision(c.ID.String(), opts...)
 }
 
-// CommitsByPage returns a paginated list of commits in the state of this commit.
-// The returned list is in reverse chronological order.
+// CommitsByPage returns a paginated list of commits in the state of this
+// commit. The returned list is in reverse chronological order.
 func (c *Commit) CommitsByPage(page, size int, opts ...CommitsByPageOptions) ([]*Commit, error) {
 	return c.repo.CommitsByPage(c.ID.String(), page, size, opts...)
 }
 
-// SearchCommits searches commit message with given pattern. The returned list is in reverse
-// chronological order.
+// SearchCommits searches commit message with given pattern. The returned list
+// is in reverse chronological order.
 func (c *Commit) SearchCommits(pattern string, opts ...SearchCommitsOptions) ([]*Commit, error) {
 	return c.repo.SearchCommits(c.ID.String(), pattern, opts...)
 }
@@ -90,18 +90,19 @@ func (c *Commit) CommitsCount(opts ...RevListCountOptions) (int64, error) {
 	return c.repo.RevListCount([]string{c.ID.String()}, opts...)
 }
 
-// FilesChangedSince returns a list of files changed after given commit ID.
+// FilesChangedAfter returns a list of files changed after given commit ID.
 func (c *Commit) FilesChangedAfter(after string, opts ...DiffNameOnlyOptions) ([]string, error) {
 	return c.repo.DiffNameOnly(after, c.ID.String(), opts...)
 }
 
-// CommitsAfter returns a list of commits after given commit ID up to this commit. The returned
-// list is in reverse chronological order.
+// CommitsAfter returns a list of commits after given commit ID up to this
+// commit. The returned list is in reverse chronological order.
 func (c *Commit) CommitsAfter(after string, opts ...RevListOptions) ([]*Commit, error) {
 	return c.repo.RevList([]string{after + "..." + c.ID.String()}, opts...)
 }
 
-// Ancestors returns a list of ancestors of this commit in reverse chronological order.
+// Ancestors returns a list of ancestors of this commit in reverse chronological
+// order.
 func (c *Commit) Ancestors(opts ...LogOptions) ([]*Commit, error) {
 	if c.ParentsCount() == 0 {
 		return []*Commit{}, nil
@@ -166,7 +167,8 @@ func (c *Commit) IsImageFile(subpath string) (bool, error) {
 	return c.isImageFile(c.Blob(subpath))
 }
 
-// IsImageFileByIndex returns true if the blob of the commit is an image by index.
+// IsImageFileByIndex returns true if the blob of the commit is an image by
+// index.
 func (c *Commit) IsImageFileByIndex(index string) (bool, error) {
 	return c.isImageFile(c.BlobByIndex(index))
 }

diff.go

@@ -215,7 +215,8 @@ type diffParser struct {
 	maxFileLines int
 	maxLineChars int
 
-	// The next line that hasn't been processed. It is used to determine what kind of process should go in.
+	// The next line that hasn't been processed. It is used to determine what kind
+	// of process should go in.
 	buffer []byte
 	isEOF  bool
 }
@@ -248,8 +249,8 @@ func (p *diffParser) parseFileHeader() (*DiffFile, error) {
 	line := string(p.buffer)
 	p.buffer = nil
 
-	// Note: In case file name is surrounded by double quotes (it happens only in git-shell).
-	// e.g. diff --git "a/xxx" "b/xxx"
+	// NOTE: In case file name is surrounded by double quotes (it happens only in
+	// git-shell). e.g. diff --git "a/xxx" "b/xxx"
 	var middle int
 	hasQuote := line[len(diffHead)] == '"'
 	if hasQuote {
@@ -494,9 +495,10 @@ func (p *diffParser) parse() (*Diff, error) {
 	return diff, nil
 }
 
-// StreamParseDiff parses the diff read from the given io.Reader. It does parse-on-read to minimize
-// the time spent on huge diffs. It accepts a channel to notify and send error (if any) to the caller
-// when the process is done. Therefore, this method should be called in a goroutine asynchronously.
+// StreamParseDiff parses the diff read from the given io.Reader. It does
+// parse-on-read to minimize the time spent on huge diffs. It accepts a channel
+// to notify and send error (if any) to the caller when the process is done.
+// Therefore, this method should be called in a goroutine asynchronously.
 func StreamParseDiff(r io.Reader, done chan<- SteamParseDiffResult, maxFiles, maxFileLines, maxLineChars int) {
 	p := &diffParser{
 		Reader:       bufio.NewReader(r),

git.go

@@ -33,9 +33,9 @@ func log(format string, args ...interface{}) {
 		return
 	}
 
-	fmt.Fprint(logOutput, logPrefix)
-	fmt.Fprintf(logOutput, format, args...)
-	fmt.Fprintln(logOutput)
+	_, _ = fmt.Fprint(logOutput, logPrefix)
+	_, _ = fmt.Fprintf(logOutput, format, args...)
+	_, _ = fmt.Fprintln(logOutput)
 }
 
 var (

hook.go

@@ -22,9 +22,11 @@ const (
 )
 
 var (
-	// ServerSideHooks contains a list of Git hooks that are supported on the server side.
+	// ServerSideHooks contains a list of Git hooks that are supported on the server
+	// side.
 	ServerSideHooks = []HookName{HookPreReceive, HookUpdate, HookPostReceive}
-	// ServerSideHookSamples contains samples of Git hooks that are supported on the server side.
+	// ServerSideHookSamples contains samples of Git hooks that are supported on the
+	// server side.
 	ServerSideHookSamples = map[HookName]string{
 		HookPreReceive: `#!/bin/sh
 #
@@ -214,7 +216,7 @@ func (h *Hook) Name() HookName {
 	return h.name
 }
 
-// path returns the path of the Git hook.
+// Path returns the path of the Git hook.
 func (h *Hook) Path() string {
 	return h.path
 }
@@ -229,8 +231,8 @@ func (h *Hook) Content() string {
 	return h.content
 }
 
-// Update writes the content of the Git hook on filesystem. It updates the memory copy of
-// the content as well.
+// Update writes the content of the Git hook on filesystem. It updates the
+// memory copy of the content as well.
 func (h *Hook) Update(content string) error {
 	h.content = strings.TrimSpace(content)
 	h.content = strings.Replace(h.content, "\r", "", -1)