Update API docs

WordPress · Apr 27, 2021 · 9b5df29 · 9b5df29
1 parent 0f7dffc
commit 9b5df29
Show file tree

Hide file tree

Showing 129 changed files with 7,619 additions and 7,203 deletions.
diff --git a/api/404.html b/api/404.html
@@ -6,7 +6,7 @@
 
 	<title>Page not found | Requests 1.7 API Documentation</title>
 
-	<link rel="stylesheet" href="resources/style.css?e99947befd7bf673c6b43ff75e9e0f170c88a60e">
+	<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
 
 </head>
 
@@ -185,7 +185,7 @@ <h1>Page not found</h1>
 	</div>
 </div>
 </div>
-<script src="resources/combined.js?dfb849e5a0593a324b6acc7cf1958a4533aaa119"></script>
+<script src="resources/combined.js?acc6a13dca3b9a5d4aa12faeacb0215044dac88d"></script>
 <script src="elementlist.js"></script>
 </body>
 </html>
diff --git a/api/annotation-group-deprecated.html b/api/annotation-group-deprecated.html
@@ -5,7 +5,7 @@
 
 	<title>Deprecated | Requests 1.7 API Documentation</title>
 
-	<link rel="stylesheet" href="resources/style.css?e99947befd7bf673c6b43ff75e9e0f170c88a60e">
+	<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
 
 </head>
 
@@ -190,28 +190,28 @@ <h1>Deprecated</h1>
 				<td class="name"><a href="class-Requests_Cookie.html">Requests_Cookie</a></td>
 				<td class="name"><code><a href="class-Requests_Cookie.html#_formatForHeader">formatForHeader()</a></code></td>
 				<td>
-								Use <code><a href="class-Requests_Cookie.html#_format_for_header">Requests_Cookie::format_for_header()</a></code><br>
+								Use Requests_Cookie::format_for_header<br>
 				</td>
 			</tr>
 			<tr>
 				<td class="name"><a href="class-Requests_Cookie.html">Requests_Cookie</a></td>
 				<td class="name"><code><a href="class-Requests_Cookie.html#_formatForSetCookie">formatForSetCookie()</a></code></td>
 				<td>
-								Use <code><a href="class-Requests_Cookie.html#_format_for_set_cookie">Requests_Cookie::format_for_set_cookie()</a></code><br>
+								Use Requests_Cookie::format_for_set_cookie<br>
 				</td>
 			</tr>
 			<tr>
 				<td class="name"><a href="class-Requests_Cookie.html">Requests_Cookie</a></td>
 				<td class="name"><code><a href="class-Requests_Cookie.html#_parseFromHeaders">parseFromHeaders()</a></code></td>
 				<td>
-								Use <code><a href="class-Requests_Cookie.html#_parse_from_headers">Requests_Cookie::parse_from_headers()</a></code><br>
+								Use Requests_Cookie::parse_from_headers<br>
 				</td>
 			</tr>
 			<tr>
 				<td class="name"><a href="class-Requests_Cookie_Jar.html">Requests_Cookie_Jar</a></td>
 				<td class="name"><code><a href="class-Requests_Cookie_Jar.html#_normalizeCookie">normalizeCookie()</a></code></td>
 				<td>
-								Use <code><a href="class-Requests_Cookie_Jar.html#_normalize_cookie">Requests_Cookie_Jar::normalize_cookie()</a></code><br>
+								Use Requests_Cookie_Jar::normalize_cookie<br>
 				</td>
 			</tr>
 		</table>
@@ -226,7 +226,7 @@ <h1>Deprecated</h1>
 	</div>
 </div>
 </div>
-<script src="resources/combined.js"></script>
+<script src="resources/combined.js?acc6a13dca3b9a5d4aa12faeacb0215044dac88d"></script>
 <script src="elementlist.js"></script>
 </body>
 </html>
diff --git a/api/class-Requests.html b/api/class-Requests.html
diff --git a/api/class-Requests_Auth.html b/api/class-Requests_Auth.html
@@ -5,7 +5,7 @@
 
 	<title>Interface Requests_Auth | Requests 1.7 API Documentation</title>
 
-	<link rel="stylesheet" href="resources/style.css?e99947befd7bf673c6b43ff75e9e0f170c88a60e">
+	<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
 
 </head>
 
@@ -166,7 +166,7 @@ <h4>Direct known implementers</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_register">#</a>
-		<code><a href="source-class-Requests_Auth.html#22-32" title="Go to source code">register</a>( <span><code><a href="class-Requests_Hooks.html">Requests_Hooks</a></code> <var>&amp; $hooks</var></span> )</code>
+		<code><a href="source-class-Requests_Auth.html#22-32" title="Go to source code">register</a>( <span><code><a href="class-Requests_Hooks.html">Requests_Hooks</a></code> <var>$hooks</var></span> )</code>
 
 		<div class="description short">
 			<p>Register hooks as needed</p>
@@ -190,7 +190,7 @@ <h4>Parameters</h4>
 
 				<h4>See</h4>
 				<div class="list">
-						<code><a href="class-Requests_Hooks.html#_register">Requests_Hooks::register()</a></code><br>
+						Requests_Hooks::register<br>
 				</div>
 
 
@@ -223,7 +223,7 @@ <h4>See</h4>
 	</div>
 </div>
 </div>
-<script src="resources/combined.js"></script>
-<script src="elementlist.js"></script>
+<script src="resources/combined.js?acc6a13dca3b9a5d4aa12faeacb0215044dac88d"></script>
+<script src="elementlist.js?aa9ec570e6976e98ef84950ea5d12015b7befca8"></script>
 </body>
 </html>
diff --git a/api/class-Requests_Auth_Basic.html b/api/class-Requests_Auth_Basic.html
@@ -5,7 +5,7 @@
 
 	<title>Class Requests_Auth_Basic | Requests 1.7 API Documentation</title>
 
-	<link rel="stylesheet" href="resources/style.css?e99947befd7bf673c6b43ff75e9e0f170c88a60e">
+	<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
 
 </head>
 
@@ -206,7 +206,7 @@ <h4>Throws</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_register">#</a>
-		<code><a href="source-class-Requests_Auth_Basic.html#49-59" title="Go to source code">register</a>( <span><code><a href="class-Requests_Hooks.html">Requests_Hooks</a></code> <var>&amp; $hooks</var></span> )</code>
+		<code><a href="source-class-Requests_Auth_Basic.html#49-59" title="Go to source code">register</a>( <span><code><a href="class-Requests_Hooks.html">Requests_Hooks</a></code> <var>$hooks</var></span> )</code>
 
 		<div class="description short">
 			<p>Register the necessary callbacks</p>
@@ -419,7 +419,7 @@ <h4>Returns</h4>
 	</div>
 </div>
 </div>
-<script src="resources/combined.js"></script>
-<script src="elementlist.js"></script>
+<script src="resources/combined.js?acc6a13dca3b9a5d4aa12faeacb0215044dac88d"></script>
+<script src="elementlist.js?aa9ec570e6976e98ef84950ea5d12015b7befca8"></script>
 </body>
 </html>
diff --git a/api/class-Requests_Cookie.html b/api/class-Requests_Cookie.html
@@ -5,7 +5,7 @@
 
 	<title>Class Requests_Cookie | Requests 1.7 API Documentation</title>
 
-	<link rel="stylesheet" href="resources/style.css?e99947befd7bf673c6b43ff75e9e0f170c88a60e">
+	<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
 
 </head>
 
@@ -132,7 +132,7 @@ <h1>Class Requests_Cookie</h1>
 
 		<b>Package:</b> <a href="package-Requests.html">Requests</a>\<a href="package-Requests.Cookies.html">Cookies</a><br>
 
-			<b>Located at</b> <a href="source-class-Requests_Cookie.html#9-500" title="Go to source code">Requests/Cookie.php</a>
+			<b>Located at</b> <a href="source-class-Requests_Cookie.html#9-505" title="Go to source code">Requests/Cookie.php</a>
 		<br>
 	</div>
 
@@ -385,7 +385,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_normalize_attribute">#</a>
-		<code><a href="source-class-Requests_Cookie.html#245-301" title="Go to source code">normalize_attribute</a>( <span>string <var>$name</var></span>, <span>string|boolean <var>$value</var></span> )</code>
+		<code><a href="source-class-Requests_Cookie.html#245-306" title="Go to source code">normalize_attribute</a>( <span>string <var>$name</var></span>, <span>string|boolean <var>$value</var></span> )</code>
 
 		<div class="description short">
 			<p>Parse an individual cookie attribute</p>
@@ -428,7 +428,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_format_for_header">#</a>
-		<code><a href="source-class-Requests_Cookie.html#303-312" title="Go to source code">format_for_header</a>( )</code>
+		<code><a href="source-class-Requests_Cookie.html#308-317" title="Go to source code">format_for_header</a>( )</code>
 
 		<div class="description short">
 			<p>Format a cookie for a Cookie header</p>
@@ -464,7 +464,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_formatForHeader">#</a>
-		<code><a href="source-class-Requests_Cookie.html#314-323" title="Go to source code">formatForHeader</a>( )</code>
+		<code><a href="source-class-Requests_Cookie.html#319-328" title="Go to source code">formatForHeader</a>( )</code>
 
 		<div class="description short">
 			<p>Format a cookie for a Cookie header</p>
@@ -475,7 +475,7 @@ <h4>Returns</h4>
 
 				<h4>Deprecated</h4>
 				<div class="list">
-						Use <code><a href="class-Requests_Cookie.html#_format_for_header">Requests_Cookie::format_for_header()</a></code><br>
+						Use Requests_Cookie::format_for_header<br>
 				</div>
 
 
@@ -505,7 +505,7 @@ <h4>Codecoverageignore</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_format_for_set_cookie">#</a>
-		<code><a href="source-class-Requests_Cookie.html#325-350" title="Go to source code">format_for_set_cookie</a>( )</code>
+		<code><a href="source-class-Requests_Cookie.html#330-355" title="Go to source code">format_for_set_cookie</a>( )</code>
 
 		<div class="description short">
 			<p>Format a cookie for a Set-Cookie header</p>
@@ -542,7 +542,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_formatForSetCookie">#</a>
-		<code><a href="source-class-Requests_Cookie.html#352-361" title="Go to source code">formatForSetCookie</a>( )</code>
+		<code><a href="source-class-Requests_Cookie.html#357-366" title="Go to source code">formatForSetCookie</a>( )</code>
 
 		<div class="description short">
 			<p>Format a cookie for a Set-Cookie header</p>
@@ -553,7 +553,7 @@ <h4>Returns</h4>
 
 				<h4>Deprecated</h4>
 				<div class="list">
-						Use <code><a href="class-Requests_Cookie.html#_format_for_set_cookie">Requests_Cookie::format_for_set_cookie()</a></code><br>
+						Use Requests_Cookie::format_for_set_cookie<br>
 				</div>
 
 
@@ -583,7 +583,7 @@ <h4>Codecoverageignore</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#___toString">#</a>
-		<code><a href="source-class-Requests_Cookie.html#363-370" title="Go to source code">__toString</a>( )</code>
+		<code><a href="source-class-Requests_Cookie.html#368-375" title="Go to source code">__toString</a>( )</code>
 
 		<div class="description short">
 			<p>Get the cookie value</p>
@@ -615,7 +615,7 @@ <h4>Codecoverageignore</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_parse">#</a>
-		<code><a href="source-class-Requests_Cookie.html#372-424" title="Go to source code">parse</a>( <span>string <var>$string</var></span>, <span> <var>$name</var> = <span class="php-quote">''</span></span>, <span> <var>$reference_time</var> = <span class="php-keyword1">null</span></span> )</code>
+		<code><a href="source-class-Requests_Cookie.html#377-429" title="Go to source code">parse</a>( <span>string <var>$string</var></span>, <span> <var>$name</var> = <span class="php-quote">''</span></span>, <span> <var>$reference_time</var> = <span class="php-keyword1">null</span></span> )</code>
 
 		<div class="description short">
 			<p>Parse a cookie string into a cookie object</p>
@@ -662,7 +662,7 @@ <h4>Returns</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_parse_from_headers">#</a>
-		<code><a href="source-class-Requests_Cookie.html#426-488" title="Go to source code">parse_from_headers</a>( <span><code><a href="class-Requests_Response_Headers.html">Requests_Response_Headers</a></code> <var>$headers</var></span>, <span><code><a href="class-Requests_IRI.html">Requests_IRI</a></code> <var>$origin</var> = <span class="php-keyword1">null</span></span>, <span>integer|null <var>$time</var> = <span class="php-keyword1">null</span></span> )</code>
+		<code><a href="source-class-Requests_Cookie.html#431-493" title="Go to source code">parse_from_headers</a>( <span><code><a href="class-Requests_Response_Headers.html">Requests_Response_Headers</a></code> <var>$headers</var></span>, <span><code><a href="class-Requests_IRI.html">Requests_IRI</a></code> <var>$origin</var> = <span class="php-keyword1">null</span></span>, <span>integer|null <var>$time</var> = <span class="php-keyword1">null</span></span> )</code>
 
 		<div class="description short">
 			<p>Parse all Set-Cookie headers from request headers</p>
@@ -698,14 +698,14 @@ <h4>Returns</h4>
 		<td class="attributes"><code>
 			 public static
 
-			string
+			array
 
 			</code>
 		</td>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_parseFromHeaders">#</a>
-		<code><a href="source-class-Requests_Cookie.html#490-499" title="Go to source code">parseFromHeaders</a>( <span><code><a href="class-Requests_Response_Headers.html">Requests_Response_Headers</a></code> <var>$headers</var></span> )</code>
+		<code><a href="source-class-Requests_Cookie.html#495-504" title="Go to source code">parseFromHeaders</a>( <span><code><a href="class-Requests_Response_Headers.html">Requests_Response_Headers</a></code> <var>$headers</var></span> )</code>
 
 		<div class="description short">
 			<p>Parse all Set-Cookie headers from request headers</p>
@@ -716,13 +716,13 @@ <h4>Returns</h4>
 
 				<h4>Deprecated</h4>
 				<div class="list">
-						Use <code><a href="class-Requests_Cookie.html#_parse_from_headers">Requests_Cookie::parse_from_headers()</a></code><br>
+						Use Requests_Cookie::parse_from_headers<br>
 				</div>
 
 
 				<h4>Returns</h4>
 				<div class="list">
-					string
+					array
 				</div>
 
 
@@ -897,7 +897,7 @@ <h4>Codecoverageignore</h4>
 	</div>
 </div>
 </div>
-<script src="resources/combined.js"></script>
-<script src="elementlist.js"></script>
+<script src="resources/combined.js?acc6a13dca3b9a5d4aa12faeacb0215044dac88d"></script>
+<script src="elementlist.js?aa9ec570e6976e98ef84950ea5d12015b7befca8"></script>
 </body>
 </html>
diff --git a/api/class-Requests_Cookie_Jar.html b/api/class-Requests_Cookie_Jar.html
@@ -5,7 +5,7 @@
 
 	<title>Class Requests_Cookie_Jar | Requests 1.7 API Documentation</title>
 
-	<link rel="stylesheet" href="resources/style.css?e99947befd7bf673c6b43ff75e9e0f170c88a60e">
+	<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
 
 </head>
 
@@ -250,7 +250,7 @@ <h4>Returns</h4>
 
 				<h4>Deprecated</h4>
 				<div class="list">
-						Use <code><a href="class-Requests_Cookie_Jar.html#_normalize_cookie">Requests_Cookie_Jar::normalize_cookie()</a></code><br>
+						Use Requests_Cookie_Jar::normalize_cookie<br>
 				</div>
 
 
@@ -314,7 +314,7 @@ <h4>Implementation of</h4>
 		<td class="attributes"><code>
 			 public 
 
-			string
+			string|null
 
 			</code>
 		</td>
@@ -339,7 +339,7 @@ <h4>Parameters</h4>
 
 				<h4>Returns</h4>
 				<div class="list">
-					string<br>Item value
+					string|null<br>Item value (null if offsetExists is false)
 				</div>
 
 
@@ -558,7 +558,7 @@ <h4>Parameters</h4>
 
 		<td class="name"><div>
 		<a class="anchor" href="#_before_redirect_check">#</a>
-		<code><a href="source-class-Requests_Cookie_Jar.html#160-174" title="Go to source code">before_redirect_check</a>( <span><code><a href="class-Requests_Response.html">Requests_Response</a></code> <var>&amp; $return</var></span> )</code>
+		<code><a href="source-class-Requests_Cookie_Jar.html#160-174" title="Go to source code">before_redirect_check</a>( <span><code><a href="class-Requests_Response.html">Requests_Response</a></code> <var>$return</var></span> )</code>
 
 		<div class="description short">
 			<p>Parse all cookies from a response and attach them to the response</p>
@@ -634,7 +634,7 @@ <h4>Var</h4>
 	</div>
 </div>
 </div>
-<script src="resources/combined.js"></script>
-<script src="elementlist.js"></script>
+<script src="resources/combined.js?acc6a13dca3b9a5d4aa12faeacb0215044dac88d"></script>
+<script src="elementlist.js?aa9ec570e6976e98ef84950ea5d12015b7befca8"></script>
 </body>
 </html>
diff --git a/api/class-Requests_Exception.html b/api/class-Requests_Exception.html
@@ -5,7 +5,7 @@
 
 	<title>Class Requests_Exception | Requests 1.7 API Documentation</title>
 
-	<link rel="stylesheet" href="resources/style.css?e99947befd7bf673c6b43ff75e9e0f170c88a60e">
+	<link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">
 
 </head>
 
@@ -294,11 +294,11 @@ <h4>Overrides</h4>
 		<code><a href="source-class-Requests_Exception.html#43-51" title="Go to source code">getType</a>( )</code>
 
 		<div class="description short">
-			<p>Like getCode(), but a string code.</p>
+			<p>Like <code><a href="class-Exception.html#_getCode">Exception::getCode()</a></code>, but a string code.</p>
 		</div>
 
 		<div class="description detailed hidden">
-			<p>Like getCode(), but a string code.</p>
+			<p>Like <code><a href="class-Exception.html#_getCode">Exception::getCode()</a></code>, but a string code.</p>
 
 
 
@@ -360,6 +360,7 @@ <h4>Codecoverageignore</h4>
 	<tr>
 		<td><code>
 __toString(), 
+__wakeup(), 
 getCode(), 
 getFile(), 
 getLine(), 
@@ -458,7 +459,7 @@ <h4>Codecoverageignore</h4>
 	</div>
 </div>
 </div>
-<script src="resources/combined.js"></script>
-<script src="elementlist.js"></script>
+<script src="resources/combined.js?acc6a13dca3b9a5d4aa12faeacb0215044dac88d"></script>
+<script src="elementlist.js?aa9ec570e6976e98ef84950ea5d12015b7befca8"></script>
 </body>
 </html>