Added pull request examples.

JNRowe · JNRowe · commit a2e6d9e6ee48 · 2011-04-29T08:04:48.000+01:00
diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -7,6 +7,7 @@ API documentation
    client
    users
    issues
+   pull_requests
    network
    repos
    commit
diff --git a/doc/api/pull_requests.rst b/doc/api/pull_requests.rst
@@ -0,0 +1,40 @@
+Pull requests
+=============
+
+.. py:currentmodule:: github2.pull_requests
+
+.. autoclass:: PullRequest(type)
+
+.. autoclass:: PullRequests(type)
+
+Examples
+--------
+
+Listing pull requests
+'''''''''''''''''''''
+
+    >>> results = github.pull_requests.list("ask/python-github2")
+
+View a pull request
+'''''''''''''''''''
+
+    >>> request = github.pull_requests.show("ask/python-github2", 28)
+    >>> pull.body
+    'This implements the github API pull requests functionality. '
+
+Open pull request
+'''''''''''''''''
+
+To open a new pull request::
+
+    >>> pull = github.pull_requests.create("ask/python-github2", "master",
+    ...                                    "JNRowe:my_new_branch",
+    ...                                    title="Fancy features")
+    >>> pull.number
+    4
+
+To attach code to an existing issue::
+
+    >>> pull = github.pull_requests.create("ask/python-github2", "master",
+    ...                                    "JNRowe:my_new_branch",
+    ...                                    issue=4)

-Original file line number
+Diff line change
    client
    users
    issues
 +   pull_requests
    network
    repos
    commit