From f3554ac62e29fd3e06c6e1fdeda914ac19cb68fa Mon Sep 17 00:00:00 2001 From: "Santiago M. Mola" Date: Tue, 7 Feb 2017 17:46:53 +0100 Subject: doc: add godoc to Signature --- plumbing/object/object.go | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'plumbing/object/object.go') 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 -- cgit