diff options
author | Joe Gregorio <jcgregorio@google.com> | 2013-02-19 15:57:37 -0500 |
---|---|---|
committer | Joe Gregorio <jcgregorio@google.com> | 2013-02-19 15:57:37 -0500 |
commit | 2676371c9effe05169ed590d92f4692b712bd2a4 (patch) | |
tree | d92b53f7bcd8d286416a41c73c40448a28d67693 /ref | |
parent | fe22a15a355f502ecdae302f428685eb4708bda4 (diff) | |
download | httplib2-2676371c9effe05169ed590d92f4692b712bd2a4.tar.gz |
Fix all whitespace issues. Patch from dhermes@google.com.
Diffstat (limited to 'ref')
-rw-r--r--[-rwxr-xr-x] | ref/cache-objects.html | 2 | ||||
-rw-r--r--[-rwxr-xr-x] | ref/http-objects.html | 6 | ||||
-rw-r--r--[-rwxr-xr-x] | ref/httplib2-example.html | 20 | ||||
-rw-r--r--[-rwxr-xr-x] | ref/index.html | 2 | ||||
-rw-r--r--[-rwxr-xr-x] | ref/module-httplib2.html | 32 | ||||
-rw-r--r--[-rwxr-xr-x] | ref/node2.html | 2 | ||||
-rw-r--r--[-rwxr-xr-x] | ref/ref.html | 2 | ||||
-rw-r--r--[-rwxr-xr-x] | ref/response-objects.html | 2 |
8 files changed, 34 insertions, 34 deletions
diff --git a/ref/cache-objects.html b/ref/cache-objects.html index dcf9465..9baa7c2 100755..100644 --- a/ref/cache-objects.html +++ b/ref/cache-objects.html @@ -57,7 +57,7 @@ <p> If you wish to supply your own caching implementation -then you will need to pass in an object that supports the +then you will need to pass in an object that supports the following methods. Note that the <tt class="module">memcache</tt> module supports this interface natively. diff --git a/ref/http-objects.html b/ref/http-objects.html index 597b7d5..603e52a 100755..100644 --- a/ref/http-objects.html +++ b/ref/http-objects.html @@ -95,7 +95,7 @@ The return value is a tuple of (response, content), the first being and instance <td><nobr><b><tt id='l2h-16' xml:id='l2h-16' class="method">add_credentials</tt></b>(</nobr></td> <td><var>name, password, </var><big>[</big><var>domain=None</var><big>]</big><var></var>)</td></tr></table></dt> <dd> -Adds a name and password that will be used when a request +Adds a name and password that will be used when a request requires authentication. Supplying the optional <var>domain</var> name will restrict these credentials to only be sent to the specified domain. If <var>domain</var> is not specified then the given credentials will @@ -108,8 +108,8 @@ be used to try to satisfy every HTTP 401 challenge. <td><var>key, cert, domain</var>)</td></tr></table></dt> <dd> Add a <var>key</var> and <var>cert</var> that will be used for an SSL connection -to the specified domain. <var>keyfile</var> is the name of a PEM formatted -file that contains your private key. <var>certfile</var> is a PEM formatted certificate chain file. +to the specified domain. <var>keyfile</var> is the name of a PEM formatted +file that contains your private key. <var>certfile</var> is a PEM formatted certificate chain file. </dl> <p> diff --git a/ref/httplib2-example.html b/ref/httplib2-example.html index 756942b..6607efe 100755..100644 --- a/ref/httplib2-example.html +++ b/ref/httplib2-example.html @@ -50,7 +50,7 @@ <h2><a name="SECTION002140000000000000000"></a><a name="httplib2-example"></a> <br> -1.1.4 Examples +1.1.4 Examples </h2> <p> @@ -67,23 +67,23 @@ assert resp['content-type'] == 'text/html' </pre></div> <p> -Here is more complex example that does a PUT +Here is more complex example that does a PUT of some text to a resource that requires authentication. The Http instance also uses a file cache -in the directory <code>.cache</code>. +in the directory <code>.cache</code>. <p> <div class="verbatim"><pre> import httplib2 h = httplib2.Http(".cache") h.add_credentials('name', 'password') -resp, content = h.request("https://example.org/chap/2", - "PUT", body="This is text", +resp, content = h.request("https://example.org/chap/2", + "PUT", body="This is text", headers={'content-type':'text/plain'} ) </pre></div> <p> -Here is an example that connects to a server that +Here is an example that connects to a server that supports the Atom Publishing Protocol. <p> @@ -108,8 +108,8 @@ resp, content = h.request(uri, "POST", body=body, headers=headers) <p> Here is an example of providing data to an HTML form processor. -In this case we presume this is a POST form. We need to take our -data and format it as "application/x-www-form-urlencoded" data and use that as a +In this case we presume this is a POST form. We need to take our +data and format it as "application/x-www-form-urlencoded" data and use that as a body for a POST request. <p> @@ -142,9 +142,9 @@ r,c = h.request("http://bitworking.org/news/") WIDTH="556" HEIGHT="20" ALIGN="BOTTOM" BORDER="0" SRC="img1.png" ALT="\begin{center}\vbox{\input{modref.ind} -}\end{center}"> +}\end{center}"> <p> - + <p> <div class="navigation"> diff --git a/ref/index.html b/ref/index.html index 3627a94..839d65e 100755..100644 --- a/ref/index.html +++ b/ref/index.html @@ -80,7 +80,7 @@ many kinds of authentication. <li><a href="contents.html">Contents</a> <li><a href="node2.html">1. Reference</a> <ul> -<li><a href="module-httplib2.html">1.1 <tt class="module">httplib2</tt> +<li><a href="module-httplib2.html">1.1 <tt class="module">httplib2</tt> A comprehensive HTTP client library.</a> <ul> <li><a href="http-objects.html">1.1.1 Http Objects</a> diff --git a/ref/module-httplib2.html b/ref/module-httplib2.html index ce4d931..155592b 100755..100644 --- a/ref/module-httplib2.html +++ b/ref/module-httplib2.html @@ -49,14 +49,14 @@ <!--End of Navigation Panel--> <h1><a name="SECTION002100000000000000000"> -1.1 <tt class="module">httplib2</tt> +1.1 <tt class="module">httplib2</tt> A comprehensive HTTP client library. </a> </h1> <p> -<a name="module-httplib2"></a> +<a name="module-httplib2"></a> <p> - + <p> <p> @@ -65,26 +65,26 @@ The <tt class="module">httplib2</tt> module is a comprehensive HTTP client libra <p> <dl> <dt><strong>HTTP and HTTPS</strong></dt> -<dd>HTTPS support is only available if the socket module was compiled with SSL support. +<dd>HTTPS support is only available if the socket module was compiled with SSL support. </dd> <dt><strong>Keep-Alive</strong></dt> -<dd>Supports HTTP 1.1 Keep-Alive, keeping the socket open and performing multiple requests over the same connection if possible. +<dd>Supports HTTP 1.1 Keep-Alive, keeping the socket open and performing multiple requests over the same connection if possible. </dd> <dt><strong>Authentication</strong></dt> <dd>The following three types of HTTP Authentication are supported. These can be used over both HTTP and HTTPS. - + <ul> <li>Digest </li> <li>Basic </li> <li>WSSE - + </li> </ul> </dd> <dt><strong>Caching</strong></dt> -<dd>The module can optionally operate with a private cache that understands the Cache-Control: header and uses both the ETag and Last-Modified cache validators. +<dd>The module can optionally operate with a private cache that understands the Cache-Control: header and uses both the ETag and Last-Modified cache validators. </dd> <dt><strong>All Methods</strong></dt> <dd>The module can handle any HTTP request method, not just GET and POST. @@ -113,8 +113,8 @@ The amount of debugging information to print. The default is 0. </dd></dl> <p> -The <tt class="module">httplib2</tt> module may raise the following Exceptions. Note that -there is an option that turns exceptions into +The <tt class="module">httplib2</tt> module may raise the following Exceptions. Note that +there is an option that turns exceptions into normal responses with an HTTP status code indicating an error occured. See <tt class="member">Http.force_exception_to_status_code</tt> @@ -127,7 +127,7 @@ The Base Exception for all exceptions raised by httplib2. <p> <dl><dt><b><span class="typelabel">exception</span> <tt id='l2h-4' xml:id='l2h-4' class="exception">RedirectMissingLocation</tt></b></dt> <dd> -A 3xx redirect response code was provided but no Location: header +A 3xx redirect response code was provided but no Location: header was provided to point to the new location. </dd></dl> @@ -177,7 +177,7 @@ are unfamiliar with. <dd> The class that represents a client HTTP interface. The <var>cache</var> parameter is either the name of a directory -to be used as a flat file cache, or it must an object that +to be used as a flat file cache, or it must an object that implements the required caching interface. The <var>timeout</var> parameter is the socket level timeout. The <var>proxy_info</var> is an instance of <tt class="class">ProxyInfo</tt> and is supplied @@ -190,9 +190,9 @@ installed for proxy support to work. <td><nobr><b><span class="typelabel">class</span> <tt id='l2h-12' xml:id='l2h-12' class="class">Response</tt></b>(</nobr></td> <td><var>info</var>)</td></tr></table></dt> <dd> -Response is a subclass of <tt class="class">dict</tt> and instances of this +Response is a subclass of <tt class="class">dict</tt> and instances of this class are returned from calls -to Http.request. The <var>info</var> parameter is either +to Http.request. The <var>info</var> parameter is either an <tt class="class">rfc822.Message</tt> or an <tt class="class">httplib.HTTPResponse</tt> object. </dl> @@ -206,7 +206,7 @@ The <var>dir_name</var> parameter is the name of the directory to use. If the directory does not exist then FileCache attempts to create the directory. The optional <var>safe</var> parameter is a funtion which generates -the cache filename for each URI. A FileCache object is +the cache filename for each URI. A FileCache object is constructed and used for caching when you pass a directory name into the constructor of <tt class="class">Http</tt>. </dl> @@ -219,7 +219,7 @@ into the constructor of <tt class="class">Http</tt>. The parameter <var>proxy_type</var> must be set to one of socks.PROXY_TYPE_XXX constants. The <var>proxy_host</var> and <var>proxy_port</var> must be set to the location of the proxy. The optional <var>proxy_rdns</var> should be set to True if -the DNS server on the proxy should be used. The <var>proxy_user</var> and +the DNS server on the proxy should be used. The <var>proxy_user</var> and <var>proxy_pass</var> are supplied when the proxy is protected by authentication. </dl> diff --git a/ref/node2.html b/ref/node2.html index e7f5de6..408be41 100755..100644 --- a/ref/node2.html +++ b/ref/node2.html @@ -63,7 +63,7 @@ <a name="CHILD_LINKS"><strong>Subsections</strong></a> <ul class="ChildLinks"> -<li><a href="module-httplib2.html">1.1 <tt class="module">httplib2</tt> +<li><a href="module-httplib2.html">1.1 <tt class="module">httplib2</tt> A comprehensive HTTP client library.</a> <ul> <li><a href="http-objects.html">1.1.1 Http Objects</a> diff --git a/ref/ref.html b/ref/ref.html index 3627a94..839d65e 100755..100644 --- a/ref/ref.html +++ b/ref/ref.html @@ -80,7 +80,7 @@ many kinds of authentication. <li><a href="contents.html">Contents</a> <li><a href="node2.html">1. Reference</a> <ul> -<li><a href="module-httplib2.html">1.1 <tt class="module">httplib2</tt> +<li><a href="module-httplib2.html">1.1 <tt class="module">httplib2</tt> A comprehensive HTTP client library.</a> <ul> <li><a href="http-objects.html">1.1.1 Http Objects</a> diff --git a/ref/response-objects.html b/ref/response-objects.html index e3fbab4..74b79f5 100755..100644 --- a/ref/response-objects.html +++ b/ref/response-objects.html @@ -103,7 +103,7 @@ redirects were encountered, you can determine the ultimate URI that the request was sent to. All Response objects contain this key value, including <code>previous</code> responses so you can determine the entire chain of redirects. If <tt class="member">Http.force_exception_to_status_code</tt> is <code>True</code> -and the number of redirects has exceeded the number of allowed number +and the number of redirects has exceeded the number of allowed number of redirects then the <tt class="class">Response</tt> object will report the error in the status code, but the complete chain of previous responses will still be in tact. |