lunny/git-lfs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

config: clarify comment on author vs committer

Browse Source 
The comment for the CurrentCommitter function used the text "author a
commit".  This is confusing, because the author and committer need not
be the same person.  The comment implied one wanted to produce the
author, whereas the function name implied one wanted to produce the
committer.

In a future version, we'll add a function for the author as well, so
let's standardize on this function being for the committer and update
the comment accordingly by saying "commit a change".
This commit is contained in:
brian m. carlson 2018-10-11 14:07:39 +00:00
parent 671c4b697f
commit 0519ab182f
No known key found for this signature in database
GPG Key ID: 2D0C9BC12F82B3A1
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
config/config.go
View File

@ -479,7 +479,7 @@ func (c *Configuration) loadGitConfig() {
}
}
// CurrentCommitter returns the name/email that would be used to author a commit
// CurrentCommitter returns the name/email that would be used to commit a change
// with this configuration. In particular, the "user.name" and "user.email"
// configuration values are used
func (c *Configuration) CurrentCommitter() (name, email string) {