From d4da228c0e874be78f7188e46ecd2622507b8ba8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Carlos=20Mart=C3=ADn=20Nieto?= Date: Mon, 9 Feb 2015 21:25:33 +0100 Subject: [PATCH] Add documentation for merge_commits() and merge_trees() --- docs/merge.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/merge.rst b/docs/merge.rst index c29277d..d8c2139 100644 --- a/docs/merge.rst +++ b/docs/merge.rst @@ -33,3 +33,13 @@ can create a commit with these two parents. >>> tree = repo.index.write_tree() >>> new_commit = repo.create_commit('HEAD', user, user, tree, [repo.head.target, other_branch_tip]) + +Lower-level methods +=================== + +These methods allow more direct control over how to perform the +merging. They do not modify the working directory and return an +in-memory Index representing the result of the merge. + +.. automethod:: pygit2.Repository.merge_commits +.. automethod:: pygit2.Repository.merge_trees