Web5design
diff --git a/‎github3/gists/comment.py
Lines changed: 13 additions & 2 deletions b/‎github3/gists/comment.py
Lines changed: 13 additions & 2 deletions
diff --git a/‎github3/gists/file.py
Lines changed: 14 additions & 2 deletions b/‎github3/gists/file.py
Lines changed: 14 additions & 2 deletions
diff --git a/‎github3/gists/gist.py
Lines changed: 34 additions & 13 deletions b/‎github3/gists/gist.py
Lines changed: 34 additions & 13 deletions
diff --git a/‎github3/gists/history.py
Lines changed: 13 additions & 3 deletions b/‎github3/gists/history.py
Lines changed: 13 additions & 3 deletions
@@ -1,10 +1,18 @@
+"""
+github3.gists.comment
+---------------------
+
+Module containing the logic for a GistComment
+
+"""
+
 from github3.models import BaseComment
 from github3.users import User
 
 
 class GistComment(BaseComment):
-    """The :class:`GistComment <GistComment>` object. This represents a comment
-    on a gist.
+
+    """This object represents a comment on a gist.
 
     Two comment instances can be checked like so::
 
@@ -17,11 +25,14 @@ class GistComment(BaseComment):
         c1.id != c2.id
 
     See also: http://developer.github.com/v3/gists/comments/
+
     """
+
     def __init__(self, comment, session=None):
         super(GistComment, self).__init__(comment, session)
 
         #: :class:`User <github3.users.User>` who made the comment
+        #: Unless it is not associated with an account
         self.user = None
         if comment.get('user'):
             self.user = User(comment.get('user'), self)  # (No coverage)
 
@@ -1,10 +1,22 @@
+"""
+github3.gists.file
+------------------
+
+Module containing the logic for the GistFile object.
+"""
+
 from github3.models import GitHubObject
 
 
 class GistFile(GitHubObject):
-    """The :class:`GistFile <GistFile>` object. This is used to represent a
-    file object returned by GitHub while interacting with gists.
+
+    """This represents the file object returned by interacting with gists.
+
+    It stores the raw url of the file, the file name, language, size and
+    content.
+
     """
+
     def __init__(self, attributes):
         super(GistFile, self).__init__(attributes)
 
 
@@ -15,11 +15,12 @@
 
 
 class Gist(GitHubCore):
-    """The :class:`Gist <Gist>` object. This object holds all the information
-    returned by Github about a gist. With it you can comment on or fork the
-    gist (assuming you are authenticated), edit or delete the gist (assuming
-    you own it).  You can also "star" or "unstar" the gist (again assuming you
-    have authenticated).
+
+    """This object holds all the information returned by Github about a gist.
+
+    With it you can comment on or fork the gist (assuming you are
+    authenticated), edit or delete the gist (assuming you own it).  You can
+    also "star" or "unstar" the gist (again assuming you have authenticated).
 
     Two gist instances can be checked like so::
 
@@ -32,7 +33,9 @@ class Gist(GitHubCore):
         g1.id != g2.id
 
     See also: http://developer.github.com/v3/gists/
+
     """
+
     def __init__(self, data, session=None):
         super(Gist, self).__init__(data, session)
         #: Number of comments on this gist
@@ -102,6 +105,7 @@ def create_comment(self, body):
 
         :param str body: (required), body of the comment
         :returns: :class:`GistComment <github3.gists.comment.GistComment>`
+
         """
         json = None
         if body:
@@ -113,7 +117,9 @@ def create_comment(self, body):
     def delete(self):
         """Delete this gist.
 
-        :returns: bool -- whether the deletion was successful"""
+        :returns: bool -- whether the deletion was successful
+
+        """
         return self._boolean(self._delete(self._api), 204, 404)
 
     @requires_auth
@@ -127,6 +133,7 @@ def edit(self, description='', files={}):
             'filename' where the former is the content of the file and the
             latter is the new name of the file.
         :returns: bool -- whether the edit was successful
+
         """
         data = {}
         json = None
@@ -146,23 +153,26 @@ def fork(self):
         """Fork this gist.
 
         :returns: :class:`Gist <Gist>` if successful, ``None`` otherwise
+
         """
         url = self._build_url('forks', base_url=self._api)
         json = self._json(self._post(url), 201)
         return Gist(json, self) if json else None
 
     def is_public(self):
-        """Checks to see if this gist is public or not.
+        """Check to see if this gist is public or not.
 
         :returns: bool -- True if public, False if private
+
         """
         return self.public
 
     @requires_auth
     def is_starred(self):
-        """Checks to see if this gist is starred by the authenticated user.
+        """Check to see if this gist is starred by the authenticated user.
 
         :returns: bool -- True if it is starred, False otherwise
+
         """
         url = self._build_url('star', base_url=self._api)
         return self._boolean(self._get(url), 204, 404)
@@ -175,7 +185,8 @@ def iter_comments(self, number=-1, etag=None):
         :param str etag: (optional), ETag from a previous request to the same
             endpoint
         :returns: generator of
-            :class:`GistComment <github3.gists.comment.GistComment>`\ s
+            :class:`GistComment <github3.gists.comment.GistComment>`
+
         """
         url = self._build_url('comments', base_url=self._api)
         return self._iter(int(number), url, GistComment, etag=etag)
@@ -192,25 +203,34 @@ def iter_commits(self, number=-1):
             Default: -1 will iterate over all commits associated with this
             gist.
         :returns: generator of
-            :class: `GistHistory <github3.gists.history.GistHistory>`\ s
+            :class:`GistHistory <github3.gists.history.GistHistory>`
+
         """
         url = self._build_url('commits', base_url=self._api)
         return self._iter(int(number), url, GistHistory)
 
     def iter_files(self):
-        """List of :class:`GistFile <GistFile>` objects representing the files
-        stored in this gist."""
+        """Iterator over the files stored in this gist.
+
+        :returns: generator of :class`GistFile <github3.gists.file.GistFile>`
+
+        """
         return iter(self._files)
 
     def iter_forks(self):
-        """List of :class:`Gist <Gist>`\ s representing forks of this gist."""
+        """Iterator of forks of this gist.
+
+        :returns: generator of :class:`Gist <Gist>`
+
+        """
         return iter(self._forks)  # (No coverage)
 
     @requires_auth
     def star(self):
         """Star this gist.
 
         :returns: bool -- True if successful, False otherwise
+
         """
         url = self._build_url('star', base_url=self._api)
         return self._boolean(self._put(url), 204, 404)
@@ -220,6 +240,7 @@ def unstar(self):
         """Un-star this gist.
 
         :returns: bool -- True if successful, False otherwise
+
         """
         url = self._build_url('star', base_url=self._api)
         return self._boolean(self._delete(url), 204, 404)
@@ -1,10 +1,18 @@
+"""
+github3.gists.history
+---------------------
+
+Module containing the logic for the GistHistory object.
+
+"""
+
 from github3.models import GitHubCore
 from github3.users import User
 
 
 class GistHistory(GitHubCore):
-    """The :class:`GistHistory <GistHistory>` object represents one version
-    (or revision) of a gist.
+
+    """Thisobject represents one version (or revision) of a gist.
 
     Two history instances can be checked like so::
 
@@ -17,6 +25,7 @@ class GistHistory(GitHubCore):
         h1.version != h2.version
 
     """
+
     def __init__(self, history, session=None):
         super(GistHistory, self).__init__(history, session)
         self._api = history.get('url', '')
@@ -53,9 +62,10 @@ def __ne__(self, other):
         return self.version != other.version
 
     def get_gist(self):
-        """Retrieves the gist at this version.
+        """Retrieve the gist at this version.
 
         :returns: :class:`Gist <github3.gists.gist.Gist>`
+
         """
         from github3.gists.gist import Gist
         json = self._json(self._get(self._api), 200)