Skip to content

Commit 9981ea4

Browse files
committed
Fix up documentation for a passing CI build
1 parent f854318 commit 9981ea4

File tree

3 files changed

+13
-6
lines changed

3 files changed

+13
-6
lines changed

docs/notifications.rst

+10-3
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@
44
Notifications
55
=============
66

7-
This part of the documentation covers the :class:`Thread <Thread>` and
8-
:class:`Subscription <Subscription>` objects.
7+
This part of the documentation covers the
8+
:class:`~github3.notifications.Thread`,
9+
:class:`~github3.notifications.RepositorySubscription`, and
10+
:class:`~github3.notifications.ThreadSubscription` objects.
911

1012
Notification Objects
1113
--------------------
@@ -15,5 +17,10 @@ Notification Objects
1517

1618
------
1719

18-
.. autoclass:: Subscription
20+
.. autoclass:: RepositorySubscription
21+
:inherited-members:
22+
23+
------
24+
25+
.. autoclass:: ThreadSubscription
1926
:inherited-members:

github3/orgs.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -672,7 +672,7 @@ def all_events(self, username, number=-1, etag=None):
672672
def events(self, number=-1, etag=None):
673673
"""Iterate over public events for this org (deprecated).
674674
675-
.. deprecated::
675+
.. deprecated:: 1.0.0
676676
677677
Use :meth:`public_events` instead.
678678

github3/pulls.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class PullDestination(models.GitHubCore):
2424
2525
Please see GitHub's `Pull Request Documentation`_ for more information.
2626
27-
.. _PullRequest Documentation:
27+
.. _Pull Request Documentation:
2828
http://developer.github.com/v3/pulls/#get-a-single-pull-request
2929
3030
.. attribute:: ref
@@ -109,7 +109,7 @@ class PullFile(models.GitHubCore):
109109
Please see GitHub's `Pull Request Files Documentation`_ for more
110110
information.
111111
112-
.. _PR Files Documentation:
112+
.. _Pull Request Files Documentation:
113113
http://developer.github.com/v3/pulls/#list-pull-requests-files
114114
115115
.. attribute:: additions_count

0 commit comments

Comments
 (0)