Commit895a788

committed

Added documentation for create_key API

Patch adds missing documentation for create_key API ingithub.py and repos/repo.pySigned-off-by: Abhijeet Kasurde <akasurde@redhat.com>

1 parentc59443c commit895a788Copy full SHA for 895a788

File tree

-2

lines changed

-2

lines changed

Lines changed: 4 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -302,8 +302,10 @@ def create_key(self, title, key, read_only=False):`
`302`	`302`	`"""Create a new key for the authenticated user.`
`303`	`303`
`304`	`304`	`: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`
`307`	`309`	:returns: :class:`Key <github3.users.Key>`
`308`	`310`	`"""`
`309`	`311`	`json=None`

Lines changed: 2 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -826,6 +826,8 @@ def create_key(self, title, key, read_only=False):`
`826`	`826`
`827`	`827`	`:param str title: (required), title of key`
`828`	`828`	`:param str key: (required), key text`
	`829`	`+ :param bool read_only: (optional), restrict key access to read-only,`
	`830`	`+ default is False`
`829`	`831`	:returns: :class:`Key <github3.users.Key>` if successful, else None
`830`	`832`	`"""`
`831`	`833`	`json=None`

Comments

(0)