Skip to content
Snippets Groups Projects
Unverified Commit 2b416aef authored by Henrik tom Wörden's avatar Henrik tom Wörden
Browse files

DOC: Enhance the documentation of configure_connection

parent 8631ae0b
No related branches found
No related tags found
No related merge requests found
...@@ -310,9 +310,12 @@ def configure_connection(**kwargs): ...@@ -310,9 +310,12 @@ def configure_connection(**kwargs):
Parameters Parameters
---------- ----------
implementation : CaosDBServerConnection
The class which implements the connection. (Default: username : str
_DefaultCaosDBServerConnection) Username for login; e.g. 'admin'.
password : str
Password for login if 'plain' is used as password_method.
password_method : str password_method : str
The name of a submodule of caosdb.connection.authentication which The name of a submodule of caosdb.connection.authentication which
...@@ -330,6 +333,10 @@ def configure_connection(**kwargs): ...@@ -330,6 +333,10 @@ def configure_connection(**kwargs):
Whether SSL certificate warnings should be ignored. Only use this for Whether SSL certificate warnings should be ignored. Only use this for
development purposes! (Default: False) development purposes! (Default: False)
implementation : CaosDBServerConnection
The class which implements the connection. (Default:
_DefaultCaosDBServerConnection)
Returns Returns
------- -------
_Connection _Connection
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment