Fix-up github3.pulls API reference

sigmavirus24 · sigmavirus24 · commit 61ae20f40004 · 2018-04-08T09:50:53.000-05:00
Clean-up our documentation build as well.
diff --git a/docs/source/api-reference/models.rst b/docs/source/api-reference/models.rst
@@ -11,5 +11,5 @@ future developers of this library.
     These classes are only to be used internally in development of this
     library.
 
-.. autoclass:: GitHubCore
+.. autoclass:: github3.models.GitHubCore
     :inherited-members:
diff --git a/docs/source/api-reference/notifications.rst b/docs/source/api-reference/notifications.rst
@@ -9,11 +9,11 @@ all of the classes used to represent notification objects in github3.py.
 Notification Objects
 --------------------
 
-.. autoclass:: Thread
+.. autoclass:: github3.notifications.Thread
     :inherited-members:
 
-.. autoclass:: ThreadSubscription
+.. autoclass:: github3.notifications.ThreadSubscription
     :inherited-members:
 
-.. autoclass:: RepositorySubscription
+.. autoclass:: github3.notifications.RepositorySubscription
     :inherited-members:
diff --git a/docs/source/api-reference/pulls.rst b/docs/source/api-reference/pulls.rst
@@ -1,33 +1,38 @@
-.. module:: github3
-.. module:: github3.pulls
+============================================
+ Pull Requests and their Associated Objects
+============================================
 
-Pull Request
-============
-
-This section of the documentation covers:
-
-- :class:`PullRequest <PullRequest>`
-- :class:`ReviewComment <ReviewComment>`
-- :class:`PullDestination <PullDestination>`
-- :class:`PullFile <PullFile>`
+This section of the documentation covers the representations of various
+objects related to the `Pull Requests API`_.
 
 Pull Request Objects
 --------------------
 
-.. autoclass:: PullRequest
+.. autoclass:: github3.pulls.ShortPullRequest
     :inherited-members:
 
-------
+.. autoclass:: github3.pulls.PullRequest
+    :inherited-members:
 
-.. autoclass:: ReviewComment
+.. autoclass:: github3.pulls.PullDestination
     :inherited-members:
 
-------
+.. autoclass:: github3.pulls.Head
+
+.. autoclass:: github3.pulls.Base
 
-.. autoclass:: PullDestination
+.. autoclass:: github3.pulls.PullFile
     :inherited-members:
 
-------
 
-.. autoclass:: PullFile
+Review Objects
+--------------
+
+.. autoclass:: github3.pulls.ReviewComment
     :inherited-members:
+
+
+.. ---
+.. links
+.. _Pull Requests API:
+    https://developer.github.com/v3/pulls/
diff --git a/docs/source/release-notes/index.rst b/docs/source/release-notes/index.rst
@@ -9,6 +9,7 @@ here with the newest releases first.
 ==================
 
 .. toctree::
+    1.0.2
     1.0.1
     1.0.0
 
diff --git a/github3/issues/event.py b/github3/issues/event.py
@@ -82,7 +82,7 @@ class RepositoryIssueEvent(IssueEvent):
 
     This object will be instantiated from calling
     :meth:`~github3.repos.repo.Repository.issue_events` or
-    :meth:`~github3.repos.repo.ShortRepository.issue_events`which call
+    :meth:`~github3.repos.repo.ShortRepository.issue_events` which call
     https://developer.github.com/v3/issues/events/#list-events-for-a-repository
 
     See also: http://developer.github.com/v3/issues/events
diff --git a/github3/issues/issue.py b/github3/issues/issue.py
@@ -197,8 +197,13 @@ def edit(self, title=None, body=None, assignee=None, state=None,
         :param str state:
             accepted values: ('open', 'closed')
         :param int milestone:
-            the NUMBER (not title) of the milestone to assign this to [1]_, or
-            0 to remove the milestone
+            the number (not title) of the milestone to assign this to,
+            or 0 to remove the milestone
+
+            .. note::
+
+                This is not the milestone's globally unique identifier, it's
+                value in :attr:`~github3.issues.milestone.Milestone.number`.
         :param list labels:
             list of labels to apply this to
         :param assignees:
@@ -209,9 +214,6 @@ def edit(self, title=None, body=None, assignee=None, state=None,
             True if successful, False otherwise
         :rtype:
             bool
-
-        .. [1] Milestone numbering starts at 1, i.e. the first milestone you
-               create is 1, the second is 2, etc.
         """
         json = None
         data = {'title': title, 'body': body, 'assignee': assignee,
