update generated docs

Sage-Bionetworks · Aug 31, 2020 · 75d8f19 · 75d8f19
1 parent a8fe02b
commit 75d8f19
Show file tree

Hide file tree

Showing 28 changed files with 381 additions and 318 deletions.
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -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: 339db537bdcffb44bbe6446783531eca
+config: 85138d91f39f84aaa48e94a465e974aa
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/Activity.html b/docs/build/html/Activity.html
@@ -6,7 +6,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Provenance &#8212; Synapse Python Client 2.1.1 documentation</title>
+    <title>Provenance &#8212; Synapse Python Client 2.2.0 documentation</title>
     <link rel="stylesheet" href="_static/custom.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
@@ -46,7 +46,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="Evaluation.html" title="Evaluations"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.1.1 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.2.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Provenance</a></li> 
       </ul>
     </div>  
@@ -243,13 +243,13 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="Evaluation.html" title="Evaluations"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.1.1 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.2.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Provenance</a></li> 
       </ul>
     </div>
     <div class="footer">
     &copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
-      Last updated on Aug 03, 2020.
+      Last updated on Aug 31, 2020.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.
     </div>
     <script type="text/javascript">

diff --git a/docs/build/html/Annotations.html b/docs/build/html/Annotations.html
@@ -6,7 +6,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Annotations &#8212; Synapse Python Client 2.1.1 documentation</title>
+    <title>Annotations &#8212; Synapse Python Client 2.2.0 documentation</title>
     <link rel="stylesheet" href="_static/custom.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
@@ -46,7 +46,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="Activity.html" title="Provenance"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.1.1 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.2.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Annotations</a></li> 
       </ul>
     </div>  
@@ -197,13 +197,13 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="Activity.html" title="Provenance"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.1.1 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.2.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Annotations</a></li> 
       </ul>
     </div>
     <div class="footer">
     &copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
-      Last updated on Aug 03, 2020.
+      Last updated on Aug 31, 2020.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.
     </div>
     <script type="text/javascript">

diff --git a/docs/build/html/Client.html b/docs/build/html/Client.html
@@ -6,7 +6,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Synapse Client &#8212; Synapse Python Client 2.1.1 documentation</title>
+    <title>Synapse Client &#8212; Synapse Python Client 2.2.0 documentation</title>
     <link rel="stylesheet" href="_static/custom.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
 
@@ -46,7 +46,7 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="S3Storage.html" title="S3 Storage Features"
              accesskey="P">previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.1.1 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.2.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Synapse Client</a></li> 
       </ul>
     </div>  
@@ -235,13 +235,14 @@ <h2>Synapse<a class="headerlink" href="#synapse" title="Permalink to this headli
 
 <dl class="py method">
 <dt id="synapseclient.Synapse.downloadTableColumns">
-<code class="sig-name descname">downloadTableColumns</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">table</span></em>, <em class="sig-param"><span class="n">columns</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#synapseclient.Synapse.downloadTableColumns" title="Permalink to this definition">¶</a></dt>
+<code class="sig-name descname">downloadTableColumns</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">table</span></em>, <em class="sig-param"><span class="n">columns</span></em>, <em class="sig-param"><span class="n">downloadLocation</span><span class="o">=</span><span class="default_value">None</span></em>, <em class="sig-param"><span class="o">**</span><span class="n">kwargs</span></em><span class="sig-paren">)</span><a class="headerlink" href="#synapseclient.Synapse.downloadTableColumns" title="Permalink to this definition">¶</a></dt>
 <dd><p>Bulk download of table-associated files.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters</dt>
 <dd class="field-odd"><ul class="simple">
 <li><p><strong>table</strong> – table query result</p></li>
 <li><p><strong>columns</strong> – a list of column names as strings</p></li>
+<li><p><strong>downloadLocation</strong> – directory into which to download the files</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns</dt>
@@ -303,8 +304,6 @@ <h2>Synapse<a class="headerlink" href="#synapse" title="Permalink to this headli
 <li><p><strong>limitSearch</strong> – a Synanpse ID used to limit the search in Synapse if entity is specified as a local
 file.  That is, if the file is stored in multiple locations in Synapse only the ones
 in the specified folder/project will be returned.</p></li>
-<li><p><strong>maxThreads</strong> – The maximum number of threads to use when downloading the file (currently only
-applies to S3 uploads)</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns</dt>
@@ -1397,6 +1396,7 @@ <h2>Synapse<a class="headerlink" href="#synapse" title="Permalink to this headli
 <li><p><strong>separator</strong> – defaults to comma</p></li>
 <li><p><strong>header</strong> – True by default</p></li>
 <li><p><strong>includeRowIdAndRowVersion</strong> – True by default</p></li>
+<li><p><strong>downloadLocation</strong> – directory path to download the CSV file to</p></li>
 </ul>
 </dd>
 <dt class="field-even">Returns</dt>
@@ -1526,13 +1526,13 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="S3Storage.html" title="S3 Storage Features"
              >previous</a> |</li>
-        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.1.1 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-0"><a href="index.html">Synapse Python Client 2.2.0 documentation</a> &#187;</li>
         <li class="nav-item nav-item-this"><a href="">Synapse Client</a></li> 
       </ul>
     </div>
     <div class="footer">
     &copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
-      Last updated on Aug 03, 2020.
+      Last updated on Aug 31, 2020.
       Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.1.2.
     </div>
     <script type="text/javascript">