Mention that MergeAnalysis is a bitmask

1 files changed, 3 insertions, 0 deletions

diff --git a/merge.go b/merge.go
index bab53e0..272bf6a 100644
--- a/merge.go
+++ b/merge.go
@@ -178,6 +178,9 @@ const (
 	MergePreferenceFastForwardOnly MergePreference = C.GIT_MERGE_PREFERENCE_FASTFORWARD_ONLY
 )
 
+// MergeAnalysis returns the possible actions which could be taken by
+// a 'git-merge' command. There may be multiple answers, so the first
+// return value is a bitmask of MergeAnalysis values.
 func (r *Repository) MergeAnalysis(theirHeads []*AnnotatedCommit) (MergeAnalysis, MergePreference, error) {
 	runtime.LockOSThread()
 	defer runtime.UnlockOSThread()