diff options
Diffstat (limited to 'pygithub3/services/issues/comments.py')
-rw-r--r-- | pygithub3/services/issues/comments.py | 53 |
1 files changed, 34 insertions, 19 deletions
diff --git a/pygithub3/services/issues/comments.py b/pygithub3/services/issues/comments.py index d007286..2b976a8 100644 --- a/pygithub3/services/issues/comments.py +++ b/pygithub3/services/issues/comments.py @@ -1,74 +1,89 @@ #!/usr/bin/env python # -*- encoding: utf-8 -*- -from pygithub3.services.base import Service +from pygithub3.services.base import Service, MimeTypeMixin -class Comments(Service): - """ Consume `Comments API +class Comments(Service, MimeTypeMixin): + """ Consume `Comments API <http://developer.github.com/v3/issues/comments>`_ """ - def list(self, user, repo, number): + def list(self, number, user=None, repo=None): """ List comments for an issue + :param int number: Issue number :param str user: Username :param str repo: Repo name - :param int number: Issue number :returns: A :doc:`result` + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.comments.list', user=user, + request = self.make_request('issues.comments.list', user=user, repo=repo, number=number) return self._get_result(request) - def get(self, user, repo, id): + def get(self, id, user=None, repo=None): """ Get a single comment + :param int id: Comment id :param str user: Username :param str repo: Repo name - :param int id: Comment id + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.comments.get', user=user, + request = self.make_request('issues.comments.get', user=user, repo=repo, id=id) return self._get(request) - def create(self, user, repo, number, message): + def create(self, number, message, user=None, repo=None): """ Create a comment on an issue - :param str user: Username - :param str repo: Repo name :param int number: Issue number :param str message: Comment message + :param str user: Username + :param str repo: Repo name .. warning:: You must be authenticated + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.comments.create', user=user, + request = self.make_request('issues.comments.create', user=user, repo=repo, number=number, body={'body': message}) return self._post(request) - def update(self, user, repo, id, message): + def update(self, id, message, user=None, repo=None): """ Update a comment on an issue - :param str user: Username - :param str repo: Repo name :param int id: Issue id :param str message: Comment message + :param str user: Username + :param str repo: Repo name .. warning:: You must be authenticated + + .. note:: + Remember :ref:`config precedence` """ - request = self.request_builder('issues.comments.edit', user=user, + request = self.request_builder('issues.comments.edit', user=user, repo=repo, id=id, body={'body': message}) return self._patch(request) - def delete(self, user, repo, id): + def delete(self, id, user=None, repo=None): """ Delete a single comment + :param int id: Comment id :param str user: Username :param str repo: Repo name - :param int id: Comment id .. warning:: You must be authenticated + + .. note:: + Remember :ref:`config precedence` """ request = self.request_builder('issues.comments.delete', user=user, repo=repo, id=id) |