aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDavid Medina <davidmedina9@gmail.com>2012-05-12 23:08:55 +0200
committerDavid Medina <davidmedina9@gmail.com>2012-05-12 23:08:55 +0200
commit748b320dd244341694c0d247d04c7f57ad4c052e (patch)
tree37b7ffad24d21f398dbb0592395b65599594c40b /docs
parentNew install environment to prod and dev (diff)
parentSome fixes/typos and 'validate_body' related (diff)
downloadpython-github3-748b320dd244341694c0d247d04c7f57ad4c052e.tar.xz
python-github3-748b320dd244341694c0d247d04c7f57ad4c052e.zip
Merge 'services/pull_requests'
Diffstat (limited to 'docs')
-rw-r--r--docs/pull_requests.rst35
-rw-r--r--docs/services.rst1
2 files changed, 36 insertions, 0 deletions
diff --git a/docs/pull_requests.rst b/docs/pull_requests.rst
new file mode 100644
index 0000000..09313eb
--- /dev/null
+++ b/docs/pull_requests.rst
@@ -0,0 +1,35 @@
+.. _Pull Requests service:
+
+Pull Requests service
+=====================
+
+**Example**::
+
+ from pygithub3 import Github
+
+ gh = Github(user='octocat', repo='sample')
+
+ pull_requests = gh.pull_requests.list().all()
+ pull_request_commits = gh.pull_requests.list_commits(2512).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:
+
+.. _github pullrequests doc: http://developer.github.com/v3/pulls
+.. _github pullrequests comments doc: http://developer.github.com/v3/pulls/comments
diff --git a/docs/services.rst b/docs/services.rst
index 2fbd2ee..190ae99 100644
--- a/docs/services.rst
+++ b/docs/services.rst
@@ -73,5 +73,6 @@ List of services
repos
gists
git_data
+ pull_requests
.. _mimetypes: http://developer.github.com/v3/mime