diff options
| author | 2012-05-12 19:04:23 +0200 | |
|---|---|---|
| committer | 2012-05-12 22:47:09 +0200 | |
| commit | 24a3ed5dcd2264a64e234ea7bd526049fafe7616 (patch) | |
| tree | 6131f221a9bf9b596dc139715d4e79f090bb55c3 /pygithub3/services/pull_requests/__init__.py | |
| parent | Deleted 'dispatch' decorator. No sense (diff) | |
| download | python-github3-24a3ed5dcd2264a64e234ea7bd526049fafe7616.tar.xz python-github3-24a3ed5dcd2264a64e234ea7bd526049fafe7616.zip | |
Some fixes/typos and 'validate_body' related
Diffstat (limited to 'pygithub3/services/pull_requests/__init__.py')
| -rw-r--r-- | pygithub3/services/pull_requests/__init__.py | 40 |
1 files changed, 31 insertions, 9 deletions
diff --git a/pygithub3/services/pull_requests/__init__.py b/pygithub3/services/pull_requests/__init__.py index 66d9e58..545f862 100644 --- a/pygithub3/services/pull_requests/__init__.py +++ b/pygithub3/services/pull_requests/__init__.py @@ -1,4 +1,5 @@ -from pygithub3.exceptions import BadRequest, NotFound +# -*- encoding: utf-8 -*- + from pygithub3.services.base import Service, MimeTypeMixin from .comments import Comments @@ -15,7 +16,10 @@ class PullRequests(Service, MimeTypeMixin): :param str user: Username :param str repo: Repository + :returns: A :doc:`result` + .. note:: + Remember :ref:`config precedence` """ return self._get_result( self.make_request('pull_requests.list', user=user, repo=repo) @@ -28,37 +32,43 @@ class PullRequests(Service, MimeTypeMixin): :param str user: Username :param str repo: Repository + .. note:: + Remember :ref:`config precedence` """ return self._get( self.make_request('pull_requests.get', number=number, user=user, repo=repo) ) - def create(self, body, user=None, repo=None): + def create(self, data, user=None, repo=None): """Create a pull request - :param dict body: Data for the new pull request + :param dict data: Input. See `github pullrequests doc`_ :param str user: Username :param str repo: Repository + .. note:: + Remember :ref:`config precedence` """ return self._post( - self.make_request('pull_requests.create', body=body, user=user, + self.make_request('pull_requests.create', body=data, user=user, repo=repo) ) - def update(self, number, body, user=None, repo=None): + def update(self, number, data, user=None, repo=None): """Update a pull request :param str number: The number of the the pull request to update - :param dict body: The data to update the pull request with + :param dict data: Input. See `github pullrequests doc`_ :param str user: Username :param str repo: Repository + .. note:: + Remember :ref:`config precedence` """ return self._patch( self.make_request('pull_requests.update', number=number, - body=body, user=user, repo=repo) + body=data, user=user, repo=repo) ) def list_commits(self, number, user=None, repo=None): @@ -67,7 +77,10 @@ class PullRequests(Service, MimeTypeMixin): :param str number: The number of the pull request to list commits for :param str user: Username :param str repo: Repository + :returns: A :doc:`result` + .. note:: + Remember :ref:`config precedence` """ return self._get_result( self.make_request('pull_requests.list_commits', number=number, @@ -80,23 +93,28 @@ class PullRequests(Service, MimeTypeMixin): :param str number: The number of the pull request to list files for :param str user: Username :param str repo: Repository + :returns: A :doc:`result` + .. note:: + Remember :ref:`config precedence` """ return self._get_result( self.make_request('pull_requests.list_files', number=number, user=user, repo=repo) ) - def merge_status(self, number, user=None, repo=None): + def is_merged(self, number, user=None, repo=None): """Gets whether a pull request has been merged or not. :param str number: The pull request to check :param str user: Username :param str repo: Repository + .. note:: + Remember :ref:`config precedence` """ return self._bool( - self.make_request('pull_requests.merge_status', number=number, + self.make_request('pull_requests.is_merged', number=number, user=user, repo=repo) ) @@ -104,9 +122,13 @@ class PullRequests(Service, MimeTypeMixin): """Merge a pull request. :param str number: The pull request to merge + :param str message: Message of pull request :param str user: Username :param str repo: Repository + .. note:: + Remember :ref:`config precedence` + This currently raises an HTTP 405 error if the request is not mergable. |
