Skip to content

Commit b97ab37

Browse files
author
Nat Williams
committed
add docs for pull requests
1 parent d1f8689 commit b97ab37

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

docs/pull_requests.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
.. _Pull Requests service:
2+
3+
Pull Requests service
4+
=====================
5+
6+
**Example**::
7+
8+
from pygithub3 import Github
9+
10+
gh = Github()
11+
12+
pull_requests = gh.pull_requests.list().all()
13+
for pr in pull_requests:
14+
commits = gh.pull_requests.list_commits(pr.number).all()
15+
16+
Pull Requests
17+
-------------
18+
19+
.. autoclass:: pygithub3.services.pull_requests.PullRequests
20+
:members:
21+
22+
.. attribute:: comments
23+
24+
:ref:`Pull Request Comments service`
25+
26+
27+
.. _Pull Request Comments service:
28+
29+
Pull Request Comments
30+
---------------------
31+
32+
.. autoclass:: pygithub3.services.pull_requests.Comments
33+
:members:

docs/services.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,5 +72,6 @@ List of services
7272
users
7373
repos
7474
gists
75+
pull_requests
7576

7677
.. _mimetypes: http://developer.github.com/v3/mime

0 commit comments

Comments
 (0)