improved docs for the get_changes function

iartarisi · Jan 15, 2013 · 618cc9b · 618cc9b
1 parent eaa7b0b
commit 618cc9b
Showing 1 changed file with 12 additions and 0 deletions.
diff --git a/github_tarballs b/github_tarballs
@@ -152,6 +152,18 @@ def get_changes(package, owner, repo, target):
 
     See http://developer.github.com/v3/repos/commits/#compare-two-commits
 
+    The dict contains:
+    {
+     "commits": [{
+         "url": ...,
+         "commit": {
+             "message": ...,
+             ...
+         },
+         ...
+     }, ...]
+    }
+
     """
     current_commit = get_commit_from_spec(package)
     url = GITHUB_COMPARE % dict(owner=owner,