From 61a1b1a63a40c57cb32ebe795bd49119d9925b7c Mon Sep 17 00:00:00 2001 From: Joel Nothman Date: Tue, 24 Jun 2014 09:47:02 -0400 Subject: [PATCH] Correct documentation for create_pull_request --- github3/repos/repo.py | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/github3/repos/repo.py b/github3/repos/repo.py index d62527b2a..cb97b7f0c 100644 --- a/github3/repos/repo.py +++ b/github3/repos/repo.py @@ -703,12 +703,11 @@ def create_milestone(self, title, state=None, description=None, @requires_auth def create_pull(self, title, base, head, body=None): - """Create a pull request using commits from ``head`` and comparing - against ``base``. + """Create a pull request of ``head`` onto ``base`` branch in this repo. :param str title: (required) - :param str base: (required), e.g., 'username:branch', or a sha - :param str head: (required), e.g., 'master', or a sha + :param str base: (required), e.g., 'master' + :param str head: (required), e.g., 'username:branch' :param str body: (optional), markdown formatted description :returns: :class:`PullRequest ` if successful, else None @@ -722,8 +721,8 @@ def create_pull_from_issue(self, issue, base, head): """Create a pull request from issue #``issue``. :param int issue: (required), issue number - :param str base: (required), e.g., 'username:branch', or a sha - :param str head: (required), e.g., 'master', or a sha + :param str base: (required), e.g., 'master' + :param str head: (required), e.g., 'username:branch' :returns: :class:`PullRequest ` if successful, else None """