8000 Correct documentation for create_pull_request · sleach/github3.py@61a1b1a · GitHub
[go: up one dir, main page]

Skip to content

Commit 61a1b1a

Browse files
committed
Correct documentation for create_pull_request
1 parent c086c67 commit 61a1b1a

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

github3/repos/repo.py

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -703,12 +703,11 @@ def create_milestone(self, title, state=None, description=None,
703703

704704
@requires_auth
705705
def create_pull(self, title, base, head, body=None):
706-
"""Create a pull request using commits from ``head`` and comparing
707-
against ``base``.
706+
"""Create a pull request of ``head`` onto ``base`` branch in this repo.
708707
709708
:param str title: (required)
710-
:param str base: (required), e.g., 'username:branch', or a sha
711-
:param str head: (required), e.g., 'master', or a sha
709+
:param str base: (required), e.g., 'master'
710+
:param str head: (required), e.g., 'username:branch'
712711
:param str body: (optional), markdown formatted description
713712
:returns: :class:`PullRequest <github3.pulls.PullRequest>` if
714713
successful, else None
@@ -722,8 +721,8 @@ def create_pull_from_issue(self, issue, base, head):
722721
"""Create a pull request from issue #``issue``.
723722
724723
:param int issue: (required), issue number
725-
:param str base: (required), e.g., 'username:branch', or a sha
726-
:param str head: (required), e.g., 'master', or a sha
724+
:param str base: (required), e.g., 'master'
725+
:param str head: (required), e.g., 'username:branch'
727726
:returns: :class:`PullRequest <github3.pulls.PullRequest>` if
728727
successful, else None
729728
"""

0 commit comments

Comments
 (0)
0