diff options
author | firm1 <firm1@users.noreply.github.com> | 2015-01-07 11:49:50 +0100 |
---|---|---|
committer | firm1 <firm1@github.com> | 2015-01-07 13:10:00 +0100 |
commit | 0d4b4ea9c84198a9b6003611a3af00ee677d09a6 (patch) | |
tree | b93d9e4134adaea53f9936b96b829ffb9667acdc | |
parent | 1dec7a822424bbe58b7b2a7787b1ea32683a9c19 (diff) | |
download | gitpython-0d4b4ea9c84198a9b6003611a3af00ee677d09a6.tar.gz |
add documentation
-rw-r--r-- | doc/source/tutorial.rst | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/doc/source/tutorial.rst b/doc/source/tutorial.rst index d9b35fda..3f45b70d 100644 --- a/doc/source/tutorial.rst +++ b/doc/source/tutorial.rst @@ -297,7 +297,10 @@ Access objects and add/remove entries. Commit the changes:: # Access the entries directly index.add(['my_new_file']) # add a new file to the index index.remove(['dir/existing_file']) - new_commit = index.commit("my commit message") + new_commit = index.commit("my commit message") # commit by commit message first + my_author = Actor("An author", "author@example.com") + my_committer = Actor("A committer", "committer@example.com") + next_commit = index.commit("my commit message", author=my_author, commiter=my_committer) # commit by commit message and author and committer Create new indices from other trees or as result of a merge. Write that result to a new index file:: |