From 52902b66672df08ecc4834bbaa48edaf78c4d52d Mon Sep 17 00:00:00 2001 From: Aaron Schulz Date: Wed, 19 Apr 2017 16:48:13 -0700 Subject: [PATCH] Document which EtcdConfig parameters are optional Change-Id: Ic6b56ed2f8789ae7920cdfc12f34b00db4a76c3a --- includes/config/EtcdConfig.php | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/includes/config/EtcdConfig.php b/includes/config/EtcdConfig.php index 0f2f64103a..d3fbd654a7 100644 --- a/includes/config/EtcdConfig.php +++ b/includes/config/EtcdConfig.php @@ -62,12 +62,12 @@ class EtcdConfig implements Config, LoggerAwareInterface { * - host: the host address and port * - protocol: either http or https * - directory: the etc "directory" were MediaWiki specific variables are located - * - encoding: one of ("JSON", "YAML") + * - encoding: one of ("JSON", "YAML"). Defaults to JSON. [optional] * - cache: BagOStuff instance or ObjectFactory spec thereof for a server cache. - * The cache will also be used as a fallback if etcd is down. - * - cacheTTL: logical cache TTL in seconds - * - skewTTL: maximum seconds to randomly lower the assigned TTL on cache save - * - timeout: seconds to wait for etcd before throwing an error + * The cache will also be used as a fallback if etcd is down. [optional] + * - cacheTTL: logical cache TTL in seconds [optional] + * - skewTTL: maximum seconds to randomly lower the assigned TTL on cache save [optional] + * - timeout: seconds to wait for etcd before throwing an error [optional] */ public function __construct( array $params ) { $params += [ -- 2.20.1