Skip to content

Commit fe9a3c2

Browse files
thomasyu888thomasyu888
committed
version v2.5.1 docs
1 parent e7192f2 commit fe9a3c2

15 files changed

+47
-20
lines changed

‎docs/build/html/Entity.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -454,7 +454,7 @@ <h3>Navigation</h3>
454454
</div>
455455
<div class="footer">
456456
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
457-
Last updated on Oct 14, 2021.
457+
Last updated on Dec 02, 2021.
458458
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
459459
</div>
460460
<script type="text/javascript">

‎docs/build/html/Multipart_upload.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ <h3>Navigation</h3>
9191
</div>
9292
<div class="footer">
9393
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
94-
Last updated on Oct 18, 2021.
94+
Last updated on Dec 02, 2021.
9595
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
9696
</div>
9797
<script type="text/javascript">

‎docs/build/html/Table.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -677,7 +677,7 @@ <h3>Module level methods<a class="headerlink" href="#module-level-methods" title
677677
<dl class="field-list simple">
678678
<dt class="field-odd">Parameters</dt>
679679
<dd class="field-odd"><ul class="simple">
680-
<li><p><strong>schema</strong> – a table <a class="reference internal" href="Entity.html#synapseclient.table.Schema" title="synapseclient.table.Schema"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schema</span></code></a> object</p></li>
680+
<li><p><strong>schema</strong> – a table <a class="reference internal" href="Entity.html#synapseclient.table.Schema" title="synapseclient.table.Schema"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schema</span></code></a> object or or the Synapse Id of an existing table.</p></li>
681681
<li><p><strong>values</strong> – <p>an object that holds the content of the tables
682682
- a <a class="reference internal" href="#synapseclient.table.RowSet" title="synapseclient.table.RowSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">RowSet</span></code></a>
683683
- a list of lists (or tuples) where each element is a row
@@ -798,7 +798,7 @@ <h3>Navigation</h3>
798798
</div>
799799
<div class="footer">
800800
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
801-
Last updated on Oct 14, 2021.
801+
Last updated on Dec 02, 2021.
802802
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
803803
</div>
804804
<script type="text/javascript">

‎docs/build/html/Utilities.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ <h3>Navigation</h3>
111111
</div>
112112
<div class="footer">
113113
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
114-
Last updated on Oct 18, 2021.
114+
Last updated on Dec 02, 2021.
115115
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
116116
</div>
117117
<script type="text/javascript">

‎docs/build/html/Versions.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ <h3>Navigation</h3>
111111
</div>
112112
<div class="footer">
113113
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
114-
Last updated on Oct 18, 2021.
114+
Last updated on Dec 02, 2021.
115115
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
116116
</div>
117117
<script type="text/javascript">

‎docs/build/html/Views.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ <h2>Creating a View<a class="headerlink" href="#creating-a-view" title="Permalin
9696
<span class="n">parent</span><span class="o">=</span><span class="n">project</span><span class="p">[</span><span class="s1">&#39;id&#39;</span><span class="p">],</span>
9797
<span class="n">scopes</span><span class="o">=</span><span class="n">project</span><span class="p">[</span><span class="s1">&#39;id&#39;</span><span class="p">],</span>
9898
<span class="n">includeEntityTypes</span><span class="o">=</span><span class="p">[</span><span class="n">EntityViewType</span><span class="o">.</span><span class="n">FILE</span><span class="p">,</span> <span class="n">EntityViewType</span><span class="o">.</span><span class="n">FOLDER</span><span class="p">],</span>
99-
<span class="n">add_default_columns</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
99+
<span class="n">addDefaultViewColumns</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span>
100100
<span class="n">view</span> <span class="o">=</span> <span class="n">syn</span><span class="o">.</span><span class="n">store</span><span class="p">(</span><span class="n">view</span><span class="p">)</span>
101101
</pre></div>
102102
</div>
@@ -199,7 +199,7 @@ <h3>Navigation</h3>
199199
</div>
200200
<div class="footer">
201201
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
202-
Last updated on Oct 14, 2021.
202+
Last updated on Dec 02, 2021.
203203
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
204204
</div>
205205
<script type="text/javascript">

‎docs/build/html/genindex.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -847,7 +847,7 @@ <h3>Navigation</h3>
847847
</div>
848848
<div class="footer">
849849
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
850-
Last updated on Oct 18, 2021.
850+
Last updated on Dec 02, 2021.
851851
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
852852
</div>
853853
<script type="text/javascript">

‎docs/build/html/index.html

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,9 @@ <h3>Navigation</h3>
5555
<span id="synapse-python-client-documentation"></span><h1>Synapse Python Client Documentation<a class="headerlink" href="#module-synapseclient" title="Permalink to this headline"></a></h1>
5656
<div class="section" id="overview">
5757
<h2>Overview<a class="headerlink" href="#overview" title="Permalink to this headline"></a></h2>
58-
<p>The <code class="docutils literal notranslate"><span class="pre">synapseclient</span></code> package provides an interface to <a class="reference external" href="http://www.synapse.org">Synapse</a>, a collaborative workspace
59-
for reproducible data intensive research projects, providing support for:</p>
58+
<p>The <code class="docutils literal notranslate"><span class="pre">synapseclient</span></code> package provides an interface to <a class="reference external" href="http://www.synapse.org">Synapse</a>, a collaborative,
59+
open-source research platform that allows teams to share data, track analyses,
60+
and collaborate, providing support for:</p>
6061
<ul class="simple">
6162
<li><p>integrated presentation of data, code and text</p></li>
6263
<li><p>fine grained access control</p></li>
@@ -2330,7 +2331,7 @@ <h3>Getting Updates<a class="headerlink" href="#getting-updates" title="Permalin
23302331
<dl class="field-list simple">
23312332
<dt class="field-odd">Parameters</dt>
23322333
<dd class="field-odd"><ul class="simple">
2333-
<li><p><strong>schema</strong> – a table <a class="reference internal" href="#synapseclient.Schema" title="synapseclient.Schema"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schema</span></code></a> object</p></li>
2334+
<li><p><strong>schema</strong> – a table <a class="reference internal" href="#synapseclient.Schema" title="synapseclient.Schema"><code class="xref py py-class docutils literal notranslate"><span class="pre">Schema</span></code></a> object or or the Synapse Id of an existing table.</p></li>
23342335
<li><p><strong>values</strong> – <p>an object that holds the content of the tables
23352336
- a <a class="reference internal" href="#synapseclient.RowSet" title="synapseclient.RowSet"><code class="xref py py-class docutils literal notranslate"><span class="pre">RowSet</span></code></a>
23362337
- a list of lists (or tuples) where each element is a row
@@ -2734,7 +2735,7 @@ <h3>Navigation</h3>
27342735
</div>
27352736
<div class="footer">
27362737
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
2737-
Last updated on Oct 18, 2021.
2738+
Last updated on Dec 02, 2021.
27382739
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
27392740
</div>
27402741
<script type="text/javascript">

‎docs/build/html/news.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1487,7 +1487,7 @@ <h3>Navigation</h3>
14871487
</div>
14881488
<div class="footer">
14891489
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
1490-
Last updated on Oct 18, 2021.
1490+
Last updated on Dec 02, 2021.
14911491
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
14921492
</div>
14931493
<script type="text/javascript">

‎docs/build/html/py-modindex.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ <h3>Navigation</h3>
181181
</div>
182182
<div class="footer">
183183
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
184-
Last updated on Oct 18, 2021.
184+
Last updated on Dec 02, 2021.
185185
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
186186
</div>
187187
<script type="text/javascript">

‎docs/build/html/reticulate.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -507,7 +507,7 @@ <h2>Views<a class="headerlink" href="#views" title="Permalink to this headline">
507507
parent = project,
508508
scopes = project,
509509
includeEntityTypes = c(synapseclient$EntityViewType$FILE, synapseclient$EntityViewType$FOLDER),
510-
add_default_columns = TRUE
510+
addDefaultViewColumns = TRUE
511511
)
512512

513513
view &lt;- syn$store(view)
@@ -637,7 +637,7 @@ <h3>Navigation</h3>
637637
</div>
638638
<div class="footer">
639639
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
640-
Last updated on Oct 14, 2021.
640+
Last updated on Dec 02, 2021.
641641
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
642642
</div>
643643
<script type="text/javascript">

‎docs/build/html/search.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ <h3>Navigation</h3>
100100
</div>
101101
<div class="footer">
102102
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
103-
Last updated on Oct 18, 2021.
103+
Last updated on Dec 02, 2021.
104104
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
105105
</div>
106106
<script type="text/javascript">

‎docs/build/html/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/build/html/synapseutils.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -817,7 +817,7 @@ <h3>Navigation</h3>
817817
</div>
818818
<div class="footer">
819819
&copy; <a href="http://sagebase.org/">Sage Bionetworks</a>.
820-
Last updated on Oct 18, 2021.
820+
Last updated on Dec 02, 2021.
821821
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.5.4.
822822
</div>
823823
<script type="text/javascript">

‎docs/news.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,32 @@
22
Release Notes
33
=============
44

5+
6+
2.5.1 (2021-12-02)
7+
==================
8+
9+
Highlights
10+
----------
11+
- Next major release (3.0.0) there will be major cosmetic changes to the cli such as
12+
removing all camel case or non-standard single dash long command line interface (cli)
13+
parameters.
14+
Example: command line arguments like `-parent` will become
15+
`--parent`. Commands that support camel case like `--parentId`
16+
will be changed to `--parent-id`.
17+
18+
Bug Fixes
19+
---------
20+
- [`SYNPY-1197 <https://sagebionetworks.jira.com/browse/SYNPY-1197>`__] -
21+
Schema is a string and strings don't have columns_to_store attributes
22+
23+
Stories
24+
-------
25+
- [`SYNPY-772 <https://sagebionetworks.jira.com/browse/SYNPY-772>`__] -
26+
update statement that appears on PyPi about Synapse to be consistent
27+
- [`SYNPY-997 <https://sagebionetworks.jira.com/browse/SYNPY-997>`__] -
28+
Typos in Views documentation
29+
30+
531
2.5.0 (2021-10-05)
632
==================
733

0 commit comments

Comments
 (0)