summaryrefslogtreecommitdiff
path: root/common/src
diff options
context:
space:
mode:
authorVictor Shyba <victor.shyba@gmail.com>2016-10-06 18:55:20 -0300
committerVictor Shyba <victor1984@riseup.net>2016-10-21 14:09:54 -0300
commitee4dc679c8ae1a87a9b5ef3b2757a3113218e4c6 (patch)
treed7046394a9cfb1f9372abacc7d54443d7410d675 /common/src
parent09a62dd1d6b076fcc7ac001d0b998ebb119feaad (diff)
[docs] explain CouchServerState parameters
create_cmd lacked an explanation and check_schema_versions lacked reasoning on why it defaults to False.
Diffstat (limited to 'common/src')
-rw-r--r--common/src/leap/soledad/common/couch/state.py8
1 files changed, 7 insertions, 1 deletions
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