8000 Last of the docstring changes · n1k0/github3.py@615da2d · GitHub
[go: up one dir, main page]

Skip to content

Commit 615da2d

Browse files
committed
Last of the docstring changes
1 parent d75e945 commit 615da2d

File tree

1 file changed

+11
-22
lines changed

1 file changed

+11
-22
lines changed

github3/users.py

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,8 @@ def delete(self):
3939
def update(self, title, key):
4040
"""Update this key.
4141
42-
:param title: (required), title of the key
43-
:type title: str
44-
:param key: (required), text of the key file
45-
:type key: str
42+
:param str title: (required), title of the key
43+
:param str key: (required), text of the key file
4644
:returns: bool
4745
"""
4846
json = None
@@ -152,8 +150,7 @@ def add_email_addresses(self, addresses=[]):
152150
"""Add the email addresses in ``addresses`` to the authenticated
153151
user's account.
154152
155-
:param addresses: (optional), email addresses to be added
156-
:type addresses: list
153+
:param list addresses: (optional), email addresses to be added
157154
:returns: list of email addresses
158155
"""
159156
json = []
@@ -176,8 +173,7 @@ def delete_email_addresses(self, addresses=[]):
176173
"""Delete the email addresses in ``addresses`` from the
177174
authenticated user's account.
178175
179-
:param addresses: (optional), email addresses to be removed
180-
:type addresses: list
176+
:param list addresses: (optional), email addresses to be removed
181177
:returns: bool
182178
"""
183179
url = self._build_url('user', 'emails')
@@ -293,20 +289,13 @@ def update(self, name=None, email=None, blog=None, company=None,
293289
"""If authenticated as this user, update the information with
294290
the information provided in the parameters.
295291
296-
:param name: e.g., 'John Smith', not login name
297-
:type name: str
298-
:param email: e.g., 'john.smith@example.com'
299-
:type email: str
300-
:param blog: e.g., 'http://www.example.com/jsmith/blog'
301-
:type blog: str
302-
:param company:
303-
:type company: str
304-
:param location:
305-
:type location: str
306-
:param hireable: defaults to False
307-
:type hireable: bool
308-
:param bio: GitHub flavored markdown
309-
:type bio: str
292+
:param str name: e.g., 'John Smith', not login name
293+
:param str email: e.g., 'john.smith@example.com'
294+
:param str blog: e.g., 'http://www.example.com/jsmith/blog'
295+
:param str company:
296+
:param str location:
297+
:param bool hireable: defaults to False
298+
:param str bio: GitHub flavored markdown
310299
:returns: bool
311300
"""
312301
user = dumps({'name': name, 'email': email, 'blog': blog,

0 commit comments

Comments
 (0)
0