8000 Correct documentation for create_pull_request by jnothman · Pull Request #260 · sigmavirus24/github3.py · GitHub
[go: up one dir, main page]
Skip to content

Correct documentation for create_pull_request #260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 28, 2014
Merged

Correct documentation for create_pull_request #260

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions github3/repos/repo.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <github3.pulls.PullRequest>` if
successful, else None
Expand All @@ -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 <github3.pulls.PullRequest>` if
successful, else None
"""
Expand Down
0