diff options
author | Santiago M. Mola <santi@mola.io> | 2017-02-07 17:46:53 +0100 |
---|---|---|
committer | Santiago M. Mola <santi@mola.io> | 2017-02-07 17:48:16 +0100 |
commit | f3554ac62e29fd3e06c6e1fdeda914ac19cb68fa (patch) | |
tree | 461b34f74a9f535ee157d31e7b3ec1bd6909de62 /plumbing/object | |
parent | 77a8f2bfbd2b19d6e19edeb7a9276bc9fe576c00 (diff) | |
download | go-git-f3554ac62e29fd3e06c6e1fdeda914ac19cb68fa.tar.gz |
doc: add godoc to Signature
Diffstat (limited to 'plumbing/object')
-rw-r--r-- | plumbing/object/object.go | 9 |
1 files changed, 6 insertions, 3 deletions
diff --git a/plumbing/object/object.go b/plumbing/object/object.go index 53c7e6c..ca5c541 100644 --- a/plumbing/object/object.go +++ b/plumbing/object/object.go @@ -77,11 +77,14 @@ func DecodeObject(s storer.EncodedObjectStorer, o plumbing.EncodedObject) (Objec // DateFormat is the format being used in the original git implementation const DateFormat = "Mon Jan 02 15:04:05 2006 -0700" -// Signature represents an action signed by a person +// Signature is used to identify who and when created a commit or tag. type Signature struct { - Name string + // Name represents a person name. It is an arbitrary string. + Name string + // Email is an email, but it cannot be assumed to be well-formed. Email string - When time.Time + // When is the timestamp of the signature. + When time.Time } // Decode decodes a byte slice into a signature |