imported patch docs
diff --git a/docs/epy/apiclient.discovery-module.html b/docs/epy/apiclient.discovery-module.html
index cabbe2c..63b3efa 100644
--- a/docs/epy/apiclient.discovery-module.html
+++ b/docs/epy/apiclient.discovery-module.html
@@ -87,25 +87,10 @@
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
- <td><span class="summary-sig"><a name="_fix_method_name"></a><span class="summary-sig-name">_fix_method_name</span>(<span class="summary-sig-arg">name</span>)</span></td>
+ <td><span class="summary-sig"><a href="apiclient.discovery-module.html#fix_method_name" class="summary-sig-name" onclick="show_private();">fix_method_name</a>(<span class="summary-sig-arg">name</span>)</span><br />
+ Fix method names to avoid reserved word conflicts.</td>
<td align="right" valign="top">
- <span class="codelink"><a href="apiclient.discovery-pysrc.html#_fix_method_name">source code</a></span>
-
- </td>
- </tr>
- </table>
-
- </td>
- </tr>
-<tr class="private">
- <td width="15%" align="right" valign="top" class="summary">
- <span class="summary-type"> </span>
- </td><td class="summary">
- <table width="100%" cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td><span class="summary-sig"><a name="_write_headers"></a><span class="summary-sig-name">_write_headers</span>(<span class="summary-sig-arg">self</span>)</span></td>
- <td align="right" valign="top">
- <span class="codelink"><a href="apiclient.discovery-pysrc.html#_write_headers">source code</a></span>
+ <span class="codelink"><a href="apiclient.discovery-pysrc.html#fix_method_name">source code</a></span>
</td>
</tr>
@@ -132,13 +117,13 @@
</td>
</tr>
-<tr class="private">
+<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
- <td><span class="summary-sig"><a href="apiclient.discovery-module.html#key2param" class="summary-sig-name" onclick="show_private();">key2param</a>(<span class="summary-sig-arg">key</span>)</span><br />
+ <td><span class="summary-sig"><a href="apiclient.discovery-module.html#key2param" class="summary-sig-name">key2param</a>(<span class="summary-sig-arg">key</span>)</span><br />
Converts key names into parameter names.</td>
<td align="right" valign="top">
<span class="codelink"><a href="apiclient.discovery-pysrc.html#key2param">source code</a></span>
@@ -172,13 +157,13 @@
</td>
</tr>
-<tr>
+<tr class="private">
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
- <td><span class="summary-sig"><a href="apiclient.discovery-module.html#build_from_document" class="summary-sig-name">build_from_document</a>(<span class="summary-sig-arg">service</span>,
+ <td><span class="summary-sig"><a href="apiclient.discovery-module.html#build_from_document" class="summary-sig-name" onclick="show_private();">build_from_document</a>(<span class="summary-sig-arg">service</span>,
<span class="summary-sig-arg">base</span>,
<span class="summary-sig-arg">future</span>=<span class="summary-sig-default">None</span>,
<span class="summary-sig-arg">http</span>=<span class="summary-sig-default">None</span>,
@@ -219,7 +204,7 @@
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
- <td><span class="summary-sig"><a name="_media_size_to_long"></a><span class="summary-sig-name">_media_size_to_long</span>(<span class="summary-sig-arg">maxSize</span>)</span><br />
+ <td><span class="summary-sig"><a href="apiclient.discovery-module.html#_media_size_to_long" class="summary-sig-name" onclick="show_private();">_media_size_to_long</a>(<span class="summary-sig-arg">maxSize</span>)</span><br />
Convert a string media size, such as 10GB or 3TB into an integer.</td>
<td align="right" valign="top">
<span class="codelink"><a href="apiclient.discovery-pysrc.html#_media_size_to_long">source code</a></span>
@@ -236,14 +221,15 @@
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
- <td><span class="summary-sig"><a name="createResource"></a><span class="summary-sig-name">createResource</span>(<span class="summary-sig-arg">http</span>,
+ <td><span class="summary-sig"><a href="apiclient.discovery-module.html#createResource" class="summary-sig-name" onclick="show_private();">createResource</a>(<span class="summary-sig-arg">http</span>,
<span class="summary-sig-arg">baseUrl</span>,
<span class="summary-sig-arg">model</span>,
<span class="summary-sig-arg">requestBuilder</span>,
<span class="summary-sig-arg">developerKey</span>,
<span class="summary-sig-arg">resourceDesc</span>,
- <span class="summary-sig-arg">futureDesc</span>,
- <span class="summary-sig-arg">schema</span>)</span></td>
+ <span class="summary-sig-arg">rootDesc</span>,
+ <span class="summary-sig-arg">schema</span>)</span><br />
+ Build a Resource from the API description.</td>
<td align="right" valign="top">
<span class="codelink"><a href="apiclient.discovery-pysrc.html#createResource">source code</a></span>
@@ -310,7 +296,7 @@
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
- <a href="apiclient.discovery-module.html#STACK_QUERY_PARAMETERS" class="summary-name" onclick="show_private();">STACK_QUERY_PARAMETERS</a> = <code title="['trace', 'fields', 'pp', 'prettyPrint', 'userIp', 'userip', 'strict']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">trace</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">fields</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">pp</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">prettyPrin</code><code class="variable-ellipsis">...</code></code>
+ <a name="STACK_QUERY_PARAMETERS"></a><span class="summary-name">STACK_QUERY_PARAMETERS</span> = <code title="['trace', 'pp', 'userip', 'strict']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">trace</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">pp</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">userip</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">strict</code><code class="variable-quote">'</code><code class="variable-group">]</code></code>
</td>
</tr>
<tr class="private">
@@ -361,6 +347,34 @@
</td>
</tr>
</table>
+<a name="fix_method_name"></a>
+<div class="private">
+<table class="details" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr><td>
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr valign="top"><td>
+ <h3 class="epydoc"><span class="sig"><span class="sig-name">fix_method_name</span>(<span class="sig-arg">name</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="apiclient.discovery-pysrc.html#fix_method_name">source code</a></span>
+ </td>
+ </tr></table>
+
+ <pre class="literalblock">
+Fix method names to avoid reserved word conflicts.
+
+Args:
+ name: string, method name.
+
+Returns:
+ The name with a '_' prefixed if the name is a reserved word.
+
+</pre>
+ <dl class="fields">
+ </dl>
+</td></tr></table>
+</div>
<a name="_add_query_parameter"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
@@ -396,7 +410,7 @@
</td></tr></table>
</div>
<a name="key2param"></a>
-<div class="private">
+<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
@@ -414,6 +428,12 @@
For example, converting "max-results" -> "max_results"
+Args:
+ key: string, the method key name.
+
+Returns:
+ A safe method name based on the key name.
+
</pre>
<dl class="fields">
</dl>
@@ -442,29 +462,26 @@
<pre class="literalblock">
Construct a Resource for interacting with an API.
-Construct a Resource object for interacting with
-an API. The serviceName and version are the
-names from the Discovery service.
+Construct a Resource object for interacting with an API. The serviceName and
+version are the names from the Discovery service.
Args:
- serviceName: string, name of the service
- version: string, the version of the service
+ serviceName: string, name of the service.
+ version: string, the version of the service.
http: httplib2.Http, An instance of httplib2.Http or something that acts
like it that HTTP requests will be made through.
- discoveryServiceUrl: string, a URI Template that points to
- the location of the discovery service. It should have two
- parameters {api} and {apiVersion} that when filled in
- produce an absolute URI to the discovery document for
- that service.
- developerKey: string, key obtained
- from https://code.google.com/apis/console
- model: apiclient.Model, converts to and from the wire format
- requestBuilder: apiclient.http.HttpRequest, encapsulator for
- an HTTP request
+ discoveryServiceUrl: string, a URI Template that points to the location of
+ the discovery service. It should have two parameters {api} and
+ {apiVersion} that when filled in produce an absolute URI to the discovery
+ document for that service.
+ developerKey: string, key obtained from
+ https://code.google.com/apis/console.
+ model: apiclient.Model, converts to and from the wire format.
+ requestBuilder: apiclient.http.HttpRequest, encapsulator for an HTTP
+ request.
Returns:
- A Resource object with methods for interacting with
- the service.
+ A Resource object with methods for interacting with the service.
</pre>
<dl class="fields">
@@ -472,7 +489,7 @@
</td></tr></table>
</div>
<a name="build_from_document"></a>
-<div>
+<div class="private">
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
@@ -494,26 +511,23 @@
<pre class="literalblock">
Create a Resource for interacting with an API.
-Same as `build()`, but constructs the Resource object
-from a discovery document that is it given, as opposed to
-retrieving one over HTTP.
+Same as `build()`, but constructs the Resource object from a discovery
+document that is it given, as opposed to retrieving one over HTTP.
Args:
- service: string, discovery document
- base: string, base URI for all HTTP requests, usually the discovery URI
- future: string, discovery document with future capabilities
- auth_discovery: dict, information about the authentication the API supports
+ service: string, discovery document.
+ base: string, base URI for all HTTP requests, usually the discovery URI.
+ future: string, discovery document with future capabilities (deprecated).
http: httplib2.Http, An instance of httplib2.Http or something that acts
like it that HTTP requests will be made through.
developerKey: string, Key for controlling API usage, generated
from the API Console.
- model: Model class instance that serializes and
- de-serializes requests and responses.
+ model: Model class instance that serializes and de-serializes requests and
+ responses.
requestBuilder: Takes an http request and packages it up to be executed.
Returns:
- A Resource object with methods for interacting with
- the service.
+ A Resource object with methods for interacting with the service.
</pre>
<dl class="fields">
@@ -553,6 +567,82 @@
</dl>
</td></tr></table>
</div>
+<a name="_media_size_to_long"></a>
+<div class="private">
+<table class="details" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr><td>
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr valign="top"><td>
+ <h3 class="epydoc"><span class="sig"><span class="sig-name">_media_size_to_long</span>(<span class="sig-arg">maxSize</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="apiclient.discovery-pysrc.html#_media_size_to_long">source code</a></span>
+ </td>
+ </tr></table>
+
+ <pre class="literalblock">
+Convert a string media size, such as 10GB or 3TB into an integer.
+
+Args:
+ maxSize: string, size as a string, such as 2MB or 7GB.
+
+Returns:
+ The size as an integer value.
+
+</pre>
+ <dl class="fields">
+ </dl>
+</td></tr></table>
+</div>
+<a name="createResource"></a>
+<div class="private">
+<table class="details" border="1" cellpadding="3"
+ cellspacing="0" width="100%" bgcolor="white">
+<tr><td>
+ <table width="100%" cellpadding="0" cellspacing="0" border="0">
+ <tr valign="top"><td>
+ <h3 class="epydoc"><span class="sig"><span class="sig-name">createResource</span>(<span class="sig-arg">http</span>,
+ <span class="sig-arg">baseUrl</span>,
+ <span class="sig-arg">model</span>,
+ <span class="sig-arg">requestBuilder</span>,
+ <span class="sig-arg">developerKey</span>,
+ <span class="sig-arg">resourceDesc</span>,
+ <span class="sig-arg">rootDesc</span>,
+ <span class="sig-arg">schema</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="apiclient.discovery-pysrc.html#createResource">source code</a></span>
+ </td>
+ </tr></table>
+
+ <pre class="literalblock">
+Build a Resource from the API description.
+
+Args:
+ http: httplib2.Http, Object to make http requests with.
+ baseUrl: string, base URL for the API. All requests are relative to this
+ URI.
+ model: apiclient.Model, converts to and from the wire format.
+ requestBuilder: class or callable that instantiates an
+ apiclient.HttpRequest object.
+ developerKey: string, key obtained from
+ https://code.google.com/apis/console
+ resourceDesc: object, section of deserialized discovery document that
+ describes a resource. Note that the top level discovery document
+ is considered a resource.
+ rootDesc: object, the entire deserialized discovery document.
+ schema: object, mapping of schema names to schema descriptions.
+
+Returns:
+ An instance of Resource with all the methods attached for interacting with
+ that resource.
+
+</pre>
+ <dl class="fields">
+ </dl>
+</td></tr></table>
+</div>
<br />
<!-- ==================== VARIABLES DETAILS ==================== -->
<a name="section-VariablesDetails"></a>
@@ -590,24 +680,6 @@
</dl>
</td></tr></table>
</div>
-<a name="STACK_QUERY_PARAMETERS"></a>
-<div class="private">
-<table class="details" border="1" cellpadding="3"
- cellspacing="0" width="100%" bgcolor="white">
-<tr><td>
- <h3 class="epydoc">STACK_QUERY_PARAMETERS</h3>
-
- <dl class="fields">
- </dl>
- <dl class="fields">
- <dt>Value:</dt>
- <dd><table><tr><td><pre class="variable">
-<code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">trace</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">fields</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">pp</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">prettyPrint</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">userIp</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">userip</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">strict</code><code class="variable-quote">'</code><code class="variable-group">]</code>
-</pre></td></tr></table>
-</dd>
- </dl>
-</td></tr></table>
-</div>
<a name="RESERVED_WORDS"></a>
<div class="private">
<table class="details" border="1" cellpadding="3"
@@ -676,7 +748,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012
+ Generated by Epydoc 3.0.1 on Thu Jun 14 08:01:54 2012
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"