Skip to content

Commit 895a788

Browse files
committed
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 <akasurde@redhat.com>
1 parent c59443c commit 895a788

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

github3/github.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -302,8 +302,10 @@ def create_key(self, title, key, read_only=False):
302302
"""Create a new key for the authenticated user.
303303
304304
:param str title: (required), key title
305-
:param key: (required), actual key contents, accepts path as a string
306-
or file-like object
305+
:param str key: (required), actual key contents, accepts path
306+
as a string or file-like object
307+
:param bool read_only: (optional), restrict key access to read-only,
308+
default to False
307309
:returns: :class:`Key <github3.users.Key>`
308310
"""
309311
json = None

github3/repos/repo.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -826,6 +826,8 @@ def create_key(self, title, key, read_only=False):
826826
827827
:param str title: (required), title of key
828828
:param str key: (required), key text
829+
:param bool read_only: (optional), restrict key access to read-only,
830+
default is False
829831
:returns: :class:`Key <github3.users.Key>` if successful, else None
830832
"""
831833
json = None

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy