From 895a788331cc9cb027dd32d35dca738cca9bbcd9 Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Tue, 2 Feb 2016 14:54:40 +0530 Subject: [PATCH] Added documentation for create_key API Patch adds missing documentation for create_key API in github.py and repos/repo.py Signed-off-by: Abhijeet Kasurde --- github3/github.py | 6 ++++-- github3/repos/repo.py | 2 ++ 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/github3/github.py b/github3/github.py index 184ffbba0..0b6120e0a 100644 --- a/github3/github.py +++ b/github3/github.py @@ -302,8 +302,10 @@ def create_key(self, title, key, read_only=False): """Create a new key for the authenticated user. :param str title: (required), key title - :param key: (required), actual key contents, accepts path as a string - or file-like object + :param str key: (required), actual key contents, accepts path + as a string or file-like object + :param bool read_only: (optional), restrict key access to read-only, + default to False :returns: :class:`Key ` """ json = None diff --git a/github3/repos/repo.py b/github3/repos/repo.py index e8810bd96..fa1020af4 100644 --- a/github3/repos/repo.py +++ b/github3/repos/repo.py @@ -826,6 +826,8 @@ def create_key(self, title, key, read_only=False): :param str title: (required), title of key :param str key: (required), key text + :param bool read_only: (optional), restrict key access to read-only, + default is False :returns: :class:`Key ` if successful, else None """ json = None