Skip to content

Commit 2e3239b

Browse files
committed
fix/add docstrings
1 parent 612baca commit 2e3239b

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

plotly/session.py

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,17 @@ def sign_in(username, api_key, **kwargs):
4444
4545
If unspecified, credentials and config are searched for in `.plotly` dir.
4646
47-
:param (str) username: The username you'd use to sign into Plotly
47+
:param (str) username: The username you'd use to sign in to Plotly
4848
:param (str) api_key: The api key associated with above username
4949
:param (list|optional) stream_ids: Stream tokens for above credentials
50+
:param (str|optional) proxy_username: The un associated with with your Proxy
51+
:param (str|optional) proxy_password: The pw associated with your Proxy un
5052
5153
:param (str|optional) plotly_domain:
5254
:param (str|optional) plotly_streaming_domain:
5355
:param (str|optional) plotly_api_domain:
54-
:param (str|optional) plotly_ssl_verification:
56+
:param (bool|optional) plotly_ssl_verification:
57+
:param (bool|optional) plotly_proxy_authorization:
5558
5659
"""
5760
# TODO: verify these _credentials with plotly

plotly/tools.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,12 @@ def set_credentials_file(username=None, api_key=None, proxy_username=None,
107107
proxy_passwd=None, stream_ids=None):
108108
"""Set the keyword-value pairs in `~/.plotly_credentials`.
109109
110+
:param (str) username: The username you'd use to sign in to Plotly
111+
:param (str) api_key: The api key associated with above username
112+
:param (list) stream_ids: Stream tokens for above credentials
113+
:param (str) proxy_username: The un associated with with your Proxy
114+
:param (str) proxy_password: The pw associated with your Proxy un
115+
110116
"""
111117
if not _file_permissions:
112118
raise exceptions.PlotlyError("You don't have proper file permissions "
@@ -158,6 +164,12 @@ def set_config_file(plotly_domain=None,
158164
plotly_proxy_authorization=None):
159165
"""Set the keyword-value pairs in `~/.plotly/.config`.
160166
167+
:param (str) plotly_domain: ex - https://plot.ly
168+
:param (str) plotly_streaming_domain: ex - https://stream.plot.ly
169+
:param (str) plotly_api_domain: ex - https://api.plot.ly
170+
:param (bool) plotly_ssl_verification: True = verify, False = don't verify
171+
:param (bool) plotly_proxy_authorization: True = use plotly proxy auth creds
172+
161173
"""
162174
if not _file_permissions:
163175
raise exceptions.PlotlyError("You don't have proper file permissions "

0 commit comments

Comments
 (0)