From 42006d715345839a7cdbeb07e20dfe26b4d84269 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=2E=20David=20Ib=C3=A1=C3=B1ez?= Date: Mon, 6 Feb 2012 23:05:19 +0100 Subject: [PATCH] docs: update talk about signatures --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index cc6c850..469e599 100644 --- a/README.md +++ b/README.md @@ -106,12 +106,21 @@ Commits Commit.tree -- the tree object attached to the commit Commit.parents -- the list of parent commits -The author and committer attributes of commit objects are tuples with four -elements, the author name and email, the unix time and time offset in -minutes: +### Signatures + +The author and committer attributes of commit objects are ``Signature`` +objects: >>> commit.author - ('J. David Ibáñez', 'jdavid.ibp@gmail.com', 1315005198, 120) + + +This is their interface: + + Signature.name -- person's name + Signature.email -- person's email address + Signature.time -- unix time + Signature.offset -- offset from utc in minutes + Trees -----------------