aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlejandro Gómez <alejandroogomez@gmail.com>2012-04-29 12:32:09 +0200
committerAlejandro Gómez <alejandroogomez@gmail.com>2012-05-27 19:54:29 +0200
commitba2b5047c0be1f02b737a6dcbef50e7455f4d7b2 (patch)
tree260f700df31c49fd7fdbe113cbb63b8d3f4dd781
parenttest Label validation errors (diff)
downloadpython-github3-ba2b5047c0be1f02b737a6dcbef50e7455f4d7b2.tar.xz
python-github3-ba2b5047c0be1f02b737a6dcbef50e7455f4d7b2.zip
add `Labels` and `Milestones` to docs
-rw-r--r--docs/issues.rst39
-rw-r--r--pygithub3/services/issues/comments.py2
-rw-r--r--pygithub3/services/issues/labels.py1
-rw-r--r--pygithub3/services/issues/milestones.py3
4 files changed, 37 insertions, 8 deletions
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',