Skip to content

Commit

Permalink
Updating docs for changes in previous commit.
Browse files Browse the repository at this point in the history
  • Loading branch information
dhermes committed Jul 31, 2017
1 parent 4ed80b8 commit 3d5833d
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/latest/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 4d96852847ec225f6bda6ce4c0135d77
config: f74829a8d80ac23fb5f1ba14167f300f
tags: 645f666f9bcd5a90fca523b33c5a78b7
6 changes: 5 additions & 1 deletion docs/latest/google.resumable_media.requests.download.html
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@

<dl class="class">
<dt id="google.resumable_media.requests.download.Download">
<em class="property">class </em><code class="descclassname">google.resumable_media.requests.download.</code><code class="descname">Download</code><span class="sig-paren">(</span><em>media_url</em>, <em>start=None</em>, <em>end=None</em>, <em>headers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#google.resumable_media.requests.download.Download" title="Permalink to this definition"></a></dt>
<em class="property">class </em><code class="descclassname">google.resumable_media.requests.download.</code><code class="descname">Download</code><span class="sig-paren">(</span><em>media_url</em>, <em>stream=None</em>, <em>start=None</em>, <em>end=None</em>, <em>headers=None</em><span class="sig-paren">)</span><a class="headerlink" href="#google.resumable_media.requests.download.Download" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal"><span class="pre">google.resumable_media.requests._helpers.RequestsMixin</span></code>, <code class="xref py py-class docutils literal"><span class="pre">google.resumable_media._download.Download</span></code></p>
<p>Helper to manage downloading a resource from a Google API.</p>
<p>“Slices” of the resource can be retrieved by specifying a range
Expand All @@ -294,6 +294,8 @@
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>media_url</strong> (<a class="reference external" href="https://docs.python.org/3.6/library/stdtypes.html#str" title="(in Python v3.6)"><em>str</em></a>) – The URL containing the media to be downloaded.</li>
<li><strong>stream</strong> (<em>IO</em><em>[</em><a class="reference external" href="https://docs.python.org/3.6/library/stdtypes.html#bytes" title="(in Python v3.6)"><em>bytes</em></a><em>]</em>) – A write-able stream (i.e. file-like object) that
the downloaded resource can be written to.</li>
<li><strong>start</strong> (<a class="reference external" href="https://docs.python.org/3.6/library/functions.html#int" title="(in Python v3.6)"><em>int</em></a>) – The first byte in a range to be downloaded. If not
provided, but <code class="docutils literal"><span class="pre">end</span></code> is provided, will download from the
beginning to <code class="docutils literal"><span class="pre">end</span></code> of the media.</li>
Expand Down Expand Up @@ -329,6 +331,8 @@
<dt id="google.resumable_media.requests.download.Download.consume">
<code class="descname">consume</code><span class="sig-paren">(</span><em>transport</em><span class="sig-paren">)</span><a class="headerlink" href="#google.resumable_media.requests.download.Download.consume" title="Permalink to this definition"></a></dt>
<dd><p>Consume the resource to be downloaded.</p>
<p>If a <code class="docutils literal"><span class="pre">stream</span></code> is attached to this download, then the downloaded
resource will be written to the stream.</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
Expand Down
2 changes: 1 addition & 1 deletion docs/latest/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 3d5833d

Please sign in to comment.