From 61c438619634c80a9fb5579beb0a6609eaf00f2d Mon Sep 17 00:00:00 2001 From: Conor Branagan Date: Wed, 11 Apr 2012 17:11:08 -0400 Subject: Add issues service for issues, comments and events. has tests and updated docs --- docs/issues.rst | 47 +++++++++++++++++++++++++++++++++++++++++++++++ docs/services.rst | 1 + 2 files changed, 48 insertions(+) create mode 100644 docs/issues.rst (limited to 'docs') diff --git a/docs/issues.rst b/docs/issues.rst new file mode 100644 index 0000000..26faf82 --- /dev/null +++ b/docs/issues.rst @@ -0,0 +1,47 @@ +.. _Issues service: + +Issues services +=============== + +**Fast sample**:: + + from pygithub3 import Github + + auth = dict(login='octocat', password='pass') + gh = Github(**auth) + + octocat_issues = gh.issues.list() + octocat_repo_issues = gh.issues.list_by_repo('octocat', 'Hello-World') + +Issues +----- + +.. autoclass:: pygithub3.services.issues.Issue + :members: + + .. attribute:: comments + + :ref:`Comments service` + + .. attribute:: events + + :ref:`Events service` + +.. _Comments service: + +Comments +---------- + +.. autoclass:: pygithub3.services.issues.Comments + :members: + +.. _ Events service: + +Events +------- + +.. autoclass:: pygithub3.services.issues.Comments + :members: + +.. _github issues doc: http://developer.github.com/v3/issues +.. _github comments doc: http://developer.github.com/v3/issues/comments \ No newline at end of file diff --git a/docs/services.rst b/docs/services.rst index 190ae99..2f268bb 100644 --- a/docs/services.rst +++ b/docs/services.rst @@ -74,5 +74,6 @@ List of services gists git_data pull_requests + issues .. _mimetypes: http://developer.github.com/v3/mime -- cgit v1.2.3-59-g8ed1b From ba2b5047c0be1f02b737a6dcbef50e7455f4d7b2 Mon Sep 17 00:00:00 2001 From: Alejandro Gómez Date: Sun, 29 Apr 2012 12:32:09 +0200 Subject: add `Labels` and `Milestones` to docs --- docs/issues.rst | 39 ++++++++++++++++++++++++++++----- pygithub3/services/issues/comments.py | 2 +- pygithub3/services/issues/labels.py | 1 + pygithub3/services/issues/milestones.py | 3 ++- 4 files changed, 37 insertions(+), 8 deletions(-) (limited to 'docs') diff --git a/docs/issues.rst b/docs/issues.rst index 26faf82..708d363 100644 --- a/docs/issues.rst +++ b/docs/issues.rst @@ -14,7 +14,7 @@ Issues services octocat_repo_issues = gh.issues.list_by_repo('octocat', 'Hello-World') Issues ------ +------ .. autoclass:: pygithub3.services.issues.Issue :members: @@ -27,21 +27,48 @@ Issues :ref:`Events service` + .. attribute:: labels + + :ref:`Labels service` + + .. attribute:: milestones + + :ref:`Milestones service` + .. _Comments service: Comments ----------- +-------- .. autoclass:: pygithub3.services.issues.Comments :members: -.. _ Events service: +.. _Events service: Events -------- +------ -.. autoclass:: pygithub3.services.issues.Comments +.. autoclass:: pygithub3.services.issues.Events + :members: + +.. _Labels service: + +Labels +------ + +.. autoclass:: pygithub3.services.issues.Labels + :members: + +.. _Milestones service: + +Milestones +---------- + +.. autoclass:: pygithub3.services.issues.Milestones :members: .. _github issues doc: http://developer.github.com/v3/issues -.. _github comments doc: http://developer.github.com/v3/issues/comments \ No newline at end of file +.. _github comments doc: http://developer.github.com/v3/issues/comments +.. _github events doc: http://developer.github.com/v3/issues/events +.. _github labels doc: http://developer.github.com/v3/issues/labels +.. _github milestones doc: http://developer.github.com/v3/issues/milestones diff --git a/pygithub3/services/issues/comments.py b/pygithub3/services/issues/comments.py index 5d6980a..d007286 100644 --- a/pygithub3/services/issues/comments.py +++ b/pygithub3/services/issues/comments.py @@ -67,7 +67,7 @@ class Comments(Service): :param str repo: Repo name :param int id: Comment id - ... warning:: + .. warning:: You must be authenticated """ request = self.request_builder('issues.comments.delete', user=user, diff --git a/pygithub3/services/issues/labels.py b/pygithub3/services/issues/labels.py index 0355918..6aea6e7 100644 --- a/pygithub3/services/issues/labels.py +++ b/pygithub3/services/issues/labels.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python # -*- encoding: utf-8 -*- from pygithub3.services.base import Service diff --git a/pygithub3/services/issues/milestones.py b/pygithub3/services/issues/milestones.py index aba6dd4..851e9f2 100644 --- a/pygithub3/services/issues/milestones.py +++ b/pygithub3/services/issues/milestones.py @@ -1,3 +1,4 @@ +#!/usr/bin/env python # -*- encoding: utf-8 -*- from pygithub3.services.base import Service @@ -94,7 +95,7 @@ class Milestones(Service): :param str repo: Repo name :param int number: Milestone number - ... warning:: + .. warning:: You must be authenticated """ request = self.request_builder('issues.milestones.delete', -- cgit v1.2.3-59-g8ed1b