From 1abcce9551c83f3ad00303a8d4ef555c9c62f8a4 Mon Sep 17 00:00:00 2001 From: David Medina Date: Tue, 3 Apr 2012 23:16:49 +0200 Subject: Fix naming --- docs/repos.rst | 4 ++-- docs/users.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) (limited to 'docs') diff --git a/docs/repos.rst b/docs/repos.rst index 79e016a..c065671 100644 --- a/docs/repos.rst +++ b/docs/repos.rst @@ -1,6 +1,6 @@ .. _Repos service: -Repos's services +Repos services =================== **Fast sample**:: @@ -50,7 +50,7 @@ You can see it better with an example: :: Repo ------- -.. autoclass:: pygithub3.services.repos.Repos +.. autoclass:: pygithub3.services.repos.Repo :members: .. attribute:: collaborators diff --git a/docs/users.rst b/docs/users.rst index 5bd2e97..139d726 100644 --- a/docs/users.rst +++ b/docs/users.rst @@ -1,6 +1,6 @@ -.. _User service: +.. _Users service: -User's services +Users services =============== **Fast sample**:: -- cgit v1.2.3-59-g8ed1b From 37e871617148bfde801a499699bbf2205125d830 Mon Sep 17 00:00:00 2001 From: David Medina Date: Tue, 3 Apr 2012 23:18:52 +0200 Subject: Gists services doc --- docs/gists.rst | 37 ++++++++++++++++++++++++++++++++++++ docs/services.rst | 1 + pygithub3/services/gists/__init__.py | 20 +++++++++++++++++++ pygithub3/services/gists/comments.py | 7 +++++++ 4 files changed, 65 insertions(+) create mode 100644 docs/gists.rst (limited to 'docs') diff --git a/docs/gists.rst b/docs/gists.rst new file mode 100644 index 0000000..3b2915f --- /dev/null +++ b/docs/gists.rst @@ -0,0 +1,37 @@ +.. _Gists service: + +Gists services +=============== + +**Fast sample**:: + + from pygithub3 import Github + + auth = dict(login='octocat', password='pass') + gh = Github(**auth) + + octocat_gists = gh.gists.list() + the_first_gist = gh.gists.get(1) + + the_first_gist_comments = gh.gists.comments.list(1) + +Gist +----- + +.. autoclass:: pygithub3.services.gists.Gist + :members: + + .. attribute:: comments + + :ref:`Comments service` + +.. _Comments service: + +Comments +---------- + +.. autoclass:: pygithub3.services.gists.Comments + :members: + +.. _github gists doc: http://developer.github.com/v3/gists +.. _github comments doc: http://developer.github.com/v3/gists/comments diff --git a/docs/services.rst b/docs/services.rst index a0fd894..e686a6e 100644 --- a/docs/services.rst +++ b/docs/services.rst @@ -61,5 +61,6 @@ List of services users repos + gists .. _mimetypes: http://developer.github.com/v3/mime diff --git a/pygithub3/services/gists/__init__.py b/pygithub3/services/gists/__init__.py index 5fbfe7a..aadb136 100644 --- a/pygithub3/services/gists/__init__.py +++ b/pygithub3/services/gists/__init__.py @@ -96,6 +96,10 @@ class Gist(Service): """ Star a gist :param int id: Gist id + + .. warning :: + You must be authenticated + """ request = self.request_builder('gists.star', id=id) self._put(request) @@ -104,6 +108,10 @@ class Gist(Service): """ Unstar a gist :param int id: Gist id + + .. warning :: + You must be authenticated + """ request = self.request_builder('gists.unstar', id=id) return self._delete(request) @@ -112,6 +120,10 @@ class Gist(Service): """ Check if a gist is starred :param int id: Gist id + + .. warning :: + You must be authenticated + """ request = self.request_builder('gists.is_starred', id=id) return self._bool(request) @@ -120,6 +132,10 @@ class Gist(Service): """ Fork a gist :param int id: Gist id + + .. warning :: + You must be authenticated + """ request = self.request_builder('gists.fork', id=id) @@ -129,6 +145,10 @@ class Gist(Service): """ Delete a gist :param int id: Gist id + + .. warning :: + You must be authenticated + """ request = self.request_builder('gists.delete', id=id) return self._delete(request) diff --git a/pygithub3/services/gists/comments.py b/pygithub3/services/gists/comments.py index 397d583..7f4955f 100644 --- a/pygithub3/services/gists/comments.py +++ b/pygithub3/services/gists/comments.py @@ -39,6 +39,7 @@ class Comments(Service, MimeTypeMixin): You must be authenticated :: + comment_service.create(1, 'comment') """ request = self.request_builder('gists.comments.create', @@ -50,6 +51,9 @@ class Comments(Service, MimeTypeMixin): :param int id: Comment id :param str message: Comment's message + + .. warning:: + You must be authenticated """ request = self.request_builder('gists.comments.update', id=id, body={'body': message}) @@ -59,6 +63,9 @@ class Comments(Service, MimeTypeMixin): """ Delete a comment :param int id: Comment id + + .. warning:: + You must be authenticated """ request = self.request_builder('gists.comments.delete', id=id) self._delete(request) -- cgit v1.2.3-59-g8ed1b From 551f29c9c54b89cef63af3d25cf4bd20e6ebb65c Mon Sep 17 00:00:00 2001 From: David Medina Date: Tue, 3 Apr 2012 23:45:28 +0200 Subject: Mimetype example in doc --- docs/services.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) (limited to 'docs') diff --git a/docs/services.rst b/docs/services.rst index e686a6e..71fa690 100644 --- a/docs/services.rst +++ b/docs/services.rst @@ -53,6 +53,16 @@ attributes or all of them. .. autoclass:: pygithub3.services.base.MimeTypeMixin :members: +**Fast example**:: + + from pygithub3 import Github + + gh = Github() + + gh.gists.comments.set_html() + comment = gh.gists.comments.list(1).all()[0] + print comment.body, comment.body_text, comment.body_html + List of services ------------------- -- cgit v1.2.3-59-g8ed1b