aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--docs/pull_requests.rst33
-rw-r--r--docs/services.rst1
2 files changed, 34 insertions, 0 deletions
diff --git a/docs/pull_requests.rst b/docs/pull_requests.rst
new file mode 100644
index 0000000..40c3435
--- /dev/null
+++ b/docs/pull_requests.rst
@@ -0,0 +1,33 @@
+.. _Pull Requests service:
+
+Pull Requests service
+=====================
+
+**Example**::
+
+ from pygithub3 import Github
+
+ gh = Github()
+
+ pull_requests = gh.pull_requests.list().all()
+ for pr in pull_requests:
+ commits = gh.pull_requests.list_commits(pr.number).all()
+
+Pull Requests
+-------------
+
+.. autoclass:: pygithub3.services.pull_requests.PullRequests
+ :members:
+
+ .. attribute:: comments
+
+ :ref:`Pull Request Comments service`
+
+
+.. _Pull Request Comments service:
+
+Pull Request Comments
+---------------------
+
+.. autoclass:: pygithub3.services.pull_requests.Comments
+ :members:
diff --git a/docs/services.rst b/docs/services.rst
index 71fa690..945501b 100644
--- a/docs/services.rst
+++ b/docs/services.rst
@@ -72,5 +72,6 @@ List of services
users
repos
gists
+ pull_requests
.. _mimetypes: http://developer.github.com/v3/mime