add docs and a few little pep8 tweaks

Nat Williams · Nat Williams · commit 30c1cec25eff · 2012-04-16T15:39:27.000-05:00
diff --git a/docs/git_data.rst b/docs/git_data.rst
@@ -0,0 +1,86 @@
+.. _Git Data service:
+
+Git Data services
+=================
+
+**Example**::
+
+  from pygithub3 import Github
+
+  gh = Github(user='someone', repo='some_repo')
+
+  a_blob = gh.git_data.blobs.get('a long sha')
+
+  dev_branch = gh.git_data.references.get('heads/add_a_thing')
+
+
+GitData
+-------
+
+.. autoclass:: pygithub3.services.git_data.GitData
+    :members:
+
+    .. attribute:: blobs
+
+        :ref:`Blobs service`
+
+    .. attribute:: commits
+
+        :ref:`Commits service`
+
+    .. attribute:: references
+
+        :ref:`References service`
+
+    .. attribute:: tags
+
+        :ref:`Tags service`
+
+    .. attribute:: trees
+
+        :ref:`Trees service`
+
+
+.. _Blobs service:
+
+Blobs
+-----
+
+.. autoclass:: pygithub3.services.git_data.Blobs
+    :members:
+
+
+.. _Commits service:
+
+Commits
+-------
+
+.. autoclass:: pygithub3.services.git_data.Commits
+    :members:
+
+
+.. _References service:
+
+References
+----------
+
+.. autoclass:: pygithub3.services.git_data.References
+    :members:
+
+
+.. _Tags service:
+
+Tags
+----
+
+.. autoclass:: pygithub3.services.git_data.Tags
+    :members:
+
+
+.. _Trees service:
+
+Trees
+-----
+
+.. autoclass:: pygithub3.services.git_data.Trees
+    :members:
diff --git a/docs/services.rst b/docs/services.rst
@@ -72,5 +72,6 @@ List of services
     users
     repos
     gists
+    git_data
 
 .. _mimetypes: http://developer.github.com/v3/mime
diff --git a/pygithub3/requests/git_data/blobs.py b/pygithub3/requests/git_data/blobs.py
@@ -14,5 +14,5 @@ class Create(Request):
     resource = Blob
     body_schema = {
         'schema': ('content', 'encoding'),
-        'required': ('content', 'encoding'), #TODO: is enc really required?
+        'required': ('content', 'encoding'),  # TODO: is enc really required?
     }
diff --git a/pygithub3/requests/git_data/tags.py b/pygithub3/requests/git_data/tags.py
@@ -13,4 +13,3 @@ class Create(Request):
         'schema': ('tag', 'message', 'object', 'type', 'tagger'),
         'required': ('type',),
     }
-
diff --git a/pygithub3/resources/gists.py b/pygithub3/resources/gists.py
@@ -15,6 +15,7 @@ class Fork(Resource):
 
     _dates = ('created_at', )
     _maps = {'user': User}
+
     def __str__(self):
         return '<GistFork>'
 
diff --git a/pygithub3/resources/git_data.py b/pygithub3/resources/git_data.py
@@ -17,7 +17,8 @@ def __str__(self):
 
 class Tag(Resource):
     _maps = {'object': Commit,
-             'tagger': Author,} # committer? tagger?
+             'tagger': Author}  # committer? tagger?
+
     def __str__(self):
         return '<Tag (%s)>' % getattr(self, 'tag', '')
 
diff --git a/pygithub3/services/git_data/commits.py b/pygithub3/services/git_data/commits.py
@@ -31,5 +31,3 @@ def create(self, data, user=None, repo=None):
             self.make_request('git_data.commits.create', user=user, repo=repo,
                               body=data)
         )
-
-

Original file line number	Diff line number	Diff line change
`@@ -14,5 +14,5 @@ class Create(Request):`
`14`	`14`	`resource = Blob`
`15`	`15`	`body_schema = {`
`16`	`16`	`'schema': ('content', 'encoding'),`
`17`		`- 'required': ('content', 'encoding'), #TODO: is enc really required?`
	`17`	`+ 'required': ('content', 'encoding'), # TODO: is enc really required?`
`18`	`18`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,4 +13,3 @@ class Create(Request):`
`13`	`13`	`'schema': ('tag', 'message', 'object', 'type', 'tagger'),`
`14`	`14`	`'required': ('type',),`
`15`	`15`	`}`
`16`		`-`
Original file line number	Diff line number	Diff line change
`@@ -31,5 +31,3 @@ def create(self, data, user=None, repo=None):`
`31`	`31`	`self.make_request('git_data.commits.create', user=user, repo=repo,`
`32`	`32`	`body=data)`
`33`	`33`	`)`
`34`		`-`
`35`		`-`