diff options
| author |   Conor Branagan <conor.branagan@gmail.com> | 2012-04-11 17:11:08 -0400 |
|---|---|---|
| committer |   Alejandro Gómez <alejandroogomez@gmail.com> | 2012-05-27 19:54:28 +0200 |
| commit | 61c438619634c80a9fb5579beb0a6609eaf00f2d (patch) | |
| tree | 1f4897572042ff397ee02e24b58215316fefdd5c /docs | |
| parent | Merge pull request #11 from dsc/patch-1 (diff) | |
| download | python-github3-61c438619634c80a9fb5579beb0a6609eaf00f2d.tar.xz python-github3-61c438619634c80a9fb5579beb0a6609eaf00f2d.zip | |
Add issues service for issues, comments and events. has tests and updated docs
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/issues.rst | 47 | ||||
| -rw-r--r-- | docs/services.rst | 1 |
2 files changed, 48 insertions, 0 deletions
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 |