From 2b416aefc64adcf38cc5d3f94be33985e40b6e2c Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <h.tomwoerden@indiscale.com>
Date: Tue, 3 Mar 2020 16:27:42 +0100
Subject: [PATCH] DOC: Enhance the documentation of configure_connection
---
src/caosdb/connection/connection.py | 13 ++++++++++---
1 file changed, 10 insertions(+), 3 deletions(-)
diff --git a/src/caosdb/connection/connection.py b/src/caosdb/connection/connection.py
index 3e2ec2cd..6ee83d34 100644
--- a/src/caosdb/connection/connection.py
+++ b/src/caosdb/connection/connection.py
@@ -310,9 +310,12 @@ def configure_connection(**kwargs):
Parameters
----------
- implementation : CaosDBServerConnection
- The class which implements the connection. (Default:
- _DefaultCaosDBServerConnection)
+
+ username : str
+ Username for login; e.g. 'admin'.
+
+ password : str
+ Password for login if 'plain' is used as password_method.
password_method : str
The name of a submodule of caosdb.connection.authentication which
@@ -330,6 +333,10 @@ def configure_connection(**kwargs):
Whether SSL certificate warnings should be ignored. Only use this for
development purposes! (Default: False)
+ implementation : CaosDBServerConnection
+ The class which implements the connection. (Default:
+ _DefaultCaosDBServerConnection)
+
Returns
-------
_Connection
--
GitLab