From 0e26174be2f5fcbad21ce7f2fbbb49a658181906 Mon Sep 17 00:00:00 2001
From: Jesse Hathaway <jesse@mbuki-mvuki.org>
Date: Tue, 2 Jun 2020 14:42:55 +0000
Subject: [PATCH] add documentation to Trailer & MessageTrailers

---
 message.go | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/message.go b/message.go
index 1c0f089..f150e87 100644
--- a/message.go
+++ b/message.go
@@ -9,11 +9,15 @@ import (
 	"unsafe"
 )
 
+// Trailer represents a single git message trailer.
 type Trailer struct {
 	key   string
 	value string
 }
 
+// MessageTrailers parses trailers out of a message, returning a slice of
+// Trailer structs. Trailers are key/value pairs in the last paragraph of a
+// message, not including any patches or conflicts that may be present.
 func MessageTrailers(message string) ([]Trailer, error) {
 
 	var trailersC C.git_message_trailer_array