Update github3.repos.pages for consistency

sigmavirus24 · sigmavirus24 · commit f38845b29768 · 2018-03-09T19:14:25.000-06:00
diff --git a/github3/repos/pages.py b/github3/repos/pages.py
@@ -1,20 +1,32 @@
 # -*- coding: utf-8 -*-
+"""GitHub Pages related logic."""
 from __future__ import unicode_literals
-from ..models import GitHubCore
 
+from .. import models
 
-class PagesInfo(GitHubCore):
-    def _update_attributes(self, info):
-        self._api = self._get_attribute(info, 'url')
 
-        #: Status of the pages site, e.g., built
-        self.status = self._get_attribute(info, 'status')
+class PagesInfo(models.GitHubCore):
+    """Representation of the information about a GitHub pages website.
+
+    .. attribute:: cname
+
+        The cname in use for the pages site, if one is set.
 
-        #: CName used for the pages site
-        self.cname = self._get_attribute(info, 'cname')
+    .. attribute:: custom_404
 
-        #: Boolean indicating whether there is a custom 404 for the pages site
-        self.custom_404 = self._get_attribute(info, 'custom_404')
+        A boolean attribute indicating whether the user configured a custom
+        404 page for this site.
+
+    .. attribute:: status
+
+        The current status of the pages site, e.g., ``built``.
+    """
+
+    def _update_attributes(self, info):
+        self._api = info['url']
+        self.cname = info['cname']
+        self.custom_404 = info['custom_404']
+        self.status = info['status']
 
     def _repr(self):
         info = self.cname or ''
@@ -24,33 +36,52 @@ def _repr(self):
         return '<Pages Info [{0}]>'.format(info)
 
 
-class PagesBuild(GitHubCore):
-    def _update_attributes(self, build):
-        self._api = self._get_attribute(build, 'url')
+class PagesBuild(models.GitHubCore):
+    """Representation of a single build of a GitHub pages website.
 
-        #: Status of the pages build, e.g., building
-        self.status = self._get_attribute(build, 'status')
+    .. attribute:: commit
 
-        #: Error dictionary containing the error message
-        self.error = self._get_attribute(build, 'error')
+        The SHA of the commit that triggered this build.
 
-        from .. import users
-        #: :class:`User <github3.users.User>` representing who pushed the
-        #: commit
-        self.pusher = self._class_attribute(build, 'pusher', users.ShortUser,
-                                            self)
+    .. attribute:: created_at
+
+        A :class:`~datetime.datetime` object representing the date and time
+        when this build was created.
 
-        #: SHA of the commit that triggered the build
-        self.commit = self._get_attribute(build, 'commit')
+    .. attribute:: duration
 
-        #: Time the build took to finish
-        self.duration = self._get_attribute(build, 'duration')
+        The time it spent processing this build.
 
-        #: Datetime the build was created
-        self.created_at = self._strptime_attribute(build, 'created_at')
+    .. attribute:: error
 
-        #: Datetime the build was updated
-        self.updated_at = self._strptime_attribute(build, 'updated_at')
+        If this build errored, a dictionary containing the error message and
+        details about the error.
+
+    .. attribute:: pusher
+
+        A :class:`~github3.users.ShortUser` representing the user who pushed
+        the commit that triggered this build.
+
+    .. attribute:: status
+
+        The current statues of the build, e.g., ``building``.
+
+    .. attribute:: updated_at
+
+        A :class:`~datetime.datetime` object representing the date and time
+        when this build was last updated.
+    """
+
+    def _update_attributes(self, build):
+        from .. import users
+        self._api = self._get_attribute(build, 'url')
+        self.commit = build['commit']
+        self.created_at = self._strptime(build['created_at'])
+        self.duration = build['duration']
+        self.error = build['error']
+        self.pusher = users.ShortUser(build['pusher'], self)
+        self.status = build['status']
+        self.updated_at = self._strptime(build['updated_at'])
 
     def _repr(self):
         return '<Pages Build [{0}/{1}]>'.format(self.commit, self.status)
