From ee4dc679c8ae1a87a9b5ef3b2757a3113218e4c6 Mon Sep 17 00:00:00 2001 From: Victor Shyba Date: Thu, 6 Oct 2016 18:55:20 -0300 Subject: [docs] explain CouchServerState parameters create_cmd lacked an explanation and check_schema_versions lacked reasoning on why it defaults to False. --- common/src/leap/soledad/common/couch/state.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) (limited to 'common') diff --git a/common/src/leap/soledad/common/couch/state.py b/common/src/leap/soledad/common/couch/state.py index 70c5fa36..523ac0b0 100644 --- a/common/src/leap/soledad/common/couch/state.py +++ b/common/src/leap/soledad/common/couch/state.py @@ -72,8 +72,14 @@ class CouchServerState(ServerState): :param couch_url: The URL for the couch database. :type couch_url: str + :param create_cmd: Command to be executed for user db creation. It will + receive a properly sanitized parameter with user db + name and should access CouchDB with necessary + privileges, which server lacks for security reasons. + :type create_cmd: str :param check_schema_versions: Whether to check couch schema version of - user dbs. + user dbs. Set to False as this is only + intended to run once during start-up. :type check_schema_versions: bool """ self.couch_url = couch_url -- cgit v1.2.3