From: Aaron Schulz <aschulz@wikimedia.org>
Date: Tue, 21 Apr 2015 04:22:55 +0000 (-0700)
Subject: Document units in MultiHttpClient
X-Git-Tag: 1.31.0-rc.0~11645^2
X-Git-Url: http://git.cyclocoop.org/%24action?a=commitdiff_plain;h=ef4119cb9eb25a0c524f365eba0ffc1d3707684f;p=lhc%2Fweb%2Fwiklou.git

Document units in MultiHttpClient

Change-Id: I0350e4e558f881e3accd01818a56e11465d92d00
---

diff --git a/includes/libs/MultiHttpClient.php b/includes/libs/MultiHttpClient.php
index fb2daa6914..8e5c17d04e 100644
--- a/includes/libs/MultiHttpClient.php
+++ b/includes/libs/MultiHttpClient.php
@@ -58,8 +58,8 @@ class MultiHttpClient {
 
 	/**
 	 * @param array $options
-	 *   - connTimeout     : default connection timeout
-	 *   - reqTimeout      : default request timeout
+	 *   - connTimeout     : default connection timeout (seconds)
+	 *   - reqTimeout      : default request timeout (seconds)
 	 *   - proxy           : HTTP proxy to use
 	 *   - usePipelining   : whether to use HTTP pipelining if possible (for all hosts)
 	 *   - maxConnsPerHost : maximum number of concurrent connections (per host)
@@ -95,8 +95,8 @@ class MultiHttpClient {
 	 *  </code>
 	 * @param array $req HTTP request array
 	 * @param array $opts
-	 *   - connTimeout    : connection timeout per request
-	 *   - reqTimeout     : post-connection timeout per request
+	 *   - connTimeout    : connection timeout per request (seconds)
+	 *   - reqTimeout     : post-connection timeout per request (seconds)
 	 * @return array Response array for request
 	 */
 	final public function run( array $req, array $opts = array() ) {
@@ -123,8 +123,8 @@ class MultiHttpClient {
 	 *
 	 * @param array $reqs Map of HTTP request arrays
 	 * @param array $opts
-	 *   - connTimeout     : connection timeout per request
-	 *   - reqTimeout      : post-connection timeout per request
+	 *   - connTimeout     : connection timeout per request (seconds)
+	 *   - reqTimeout      : post-connection timeout per request (seconds)
 	 *   - usePipelining   : whether to use HTTP pipelining if possible
 	 *   - maxConnsPerHost : maximum number of concurrent connections (per host)
 	 * @return array $reqs With response array populated for each