Skip to content

Commit 571e481

Browse files
committed
Deployed ac3c624 to 0.14 with MkDocs 1.6.1 and mike 2.1.3
1 parent a6ead56 commit 571e481

File tree

17 files changed

+503
-197
lines changed

17 files changed

+503
-197
lines changed

0.14/api/datajoint/__init__/index.html

Lines changed: 55 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4495,7 +4495,12 @@ <h2 id="datajoint.kill" class="doc doc-heading">
44954495
</td>
44964496
<td>
44974497
<div class="doc-md-description">
4498-
<p>order by a single attribute or the list of attributes. defaults to 'id'. Restrictions are specified as strings and can involve any of the attributes of information_schema.processlist: ID, USER, HOST, DB, COMMAND, TIME, STATE, INFO. Examples: dj.kill('HOST LIKE "%compute%"') lists only connections from hosts containing "compute". dj.kill('TIME &gt; 600') lists only connections in their current state for more than 10 minutes</p>
4498+
<p>order by a single attribute or the list of attributes. defaults to 'id'.</p>
4499+
<p>Restrictions are specified as strings and can involve any of the attributes of
4500+
information_schema.processlist: ID, USER, HOST, DB, COMMAND, TIME, STATE, INFO.</p>
4501+
<p>Examples:
4502+
dj.kill('HOST LIKE "%compute%"') lists only connections from hosts containing "compute".
4503+
dj.kill('TIME &gt; 600') lists only connections in their current state for more than 10 minutes</p>
44994504
</div>
45004505
</td>
45014506
<td>
@@ -6098,7 +6103,8 @@ <h3 id="datajoint.Connection.query" class="doc doc-heading">
60986103
</td>
60996104
<td>
61006105
<div class="doc-md-description">
6101-
<p>If as_dict is set to True, the returned cursor objects returns query results as dictionary.</p>
6106+
<p>If as_dict is set to True, the returned cursor objects returns
6107+
query results as dictionary.</p>
61026108
</div>
61036109
</td>
61046110
<td>
@@ -6670,7 +6676,9 @@ <h2 id="datajoint.conn" class="doc doc-heading">
66706676
</td>
66716677
<td>
66726678
<div class="doc-md-description">
6673-
<p>TLS encryption option. Valid options are: True (required), False (required no TLS), None (TLS preferred, default), dict (Manually specify values per <a href="https://dev.mysql.com/doc/refman/5.7/en/connection-options.html#encrypted-connection-options">https://dev.mysql.com/doc/refman/5.7/en/connection-options.html#encrypted-connection-options</a>).</p>
6679+
<p>TLS encryption option. Valid options are: True (required), False
6680+
(required no TLS), None (TLS preferred, default), dict (Manually specify values per
6681+
<a href="https://dev.mysql.com/doc/refman/5.7/en/connection-options.html#encrypted-connection-options">https://dev.mysql.com/doc/refman/5.7/en/connection-options.html#encrypted-connection-options</a>).</p>
66746682
</div>
66756683
</td>
66766684
<td>
@@ -10077,7 +10085,8 @@ <h3 id="datajoint.Schema.activate" class="doc doc-heading">
1007710085
</td>
1007810086
<td>
1007910087
<div class="doc-md-description">
10080-
<p>the database schema to associate. schema_name=None is used to assert that the schema has already been activated.</p>
10088+
<p>the database schema to associate.
10089+
schema_name=None is used to assert that the schema has already been activated.</p>
1008110090
</div>
1008210091
</td>
1008310092
<td>
@@ -10122,7 +10131,8 @@ <h3 id="datajoint.Schema.activate" class="doc doc-heading">
1012210131
</td>
1012310132
<td>
1012410133
<div class="doc-md-description">
10125-
<p>If False, do not create tables and raise errors when attempting to access missing tables.</p>
10134+
<p>If False, do not create tables and raise errors when attempting
10135+
to access missing tables.</p>
1012610136
</div>
1012710137
</td>
1012810138
<td>
@@ -10137,7 +10147,8 @@ <h3 id="datajoint.Schema.activate" class="doc doc-heading">
1013710147
</td>
1013810148
<td>
1013910149
<div class="doc-md-description">
10140-
<p>a mapping with additional objects to make available to the context in which table classes are declared.</p>
10150+
<p>a mapping with additional objects to make available to the context
10151+
in which table classes are declared.</p>
1014110152
</div>
1014210153
</td>
1014310154
<td>
@@ -13238,7 +13249,8 @@ <h3 id="datajoint.Table.declare" class="doc doc-heading">
1323813249
</td>
1323913250
<td>
1324013251
<div class="doc-md-description">
13241-
<p>the context for foreign key resolution. If None, foreign keys are not allowed.</p>
13252+
<p>the context for foreign key resolution. If None, foreign keys are
13253+
not allowed.</p>
1324213254
</div>
1324313255
</td>
1324413256
<td>
@@ -13582,7 +13594,9 @@ <h3 id="datajoint.Table.parents" class="doc doc-heading">
1358213594
</td>
1358313595
<td>
1358413596
<div class="doc-md-description">
13585-
<p>if None, then all parents are returned. If True, then only foreign keys composed of primary key attributes are considered. If False, return foreign keys including at least one secondary attribute.</p>
13597+
<p>if None, then all parents are returned. If True, then only foreign keys composed of
13598+
primary key attributes are considered. If False, return foreign keys including at least one
13599+
secondary attribute.</p>
1358613600
</div>
1358713601
</td>
1358813602
<td>
@@ -13637,7 +13651,8 @@ <h3 id="datajoint.Table.parents" class="doc doc-heading">
1363713651
</td>
1363813652
<td>
1363913653
<div class="doc-md-description">
13640-
<p>list of parents as table names or table objects with (optional) foreign key information.</p>
13654+
<p>list of parents as table names or table objects
13655+
with (optional) foreign key information.</p>
1364113656
</div>
1364213657
</td>
1364313658
</tr>
@@ -13732,7 +13747,9 @@ <h3 id="datajoint.Table.children" class="doc doc-heading">
1373213747
</td>
1373313748
<td>
1373413749
<div class="doc-md-description">
13735-
<p>if None, then all children are returned. If True, then only foreign keys composed of primary key attributes are considered. If False, return foreign keys including at least one secondary attribute.</p>
13750+
<p>if None, then all children are returned. If True, then only foreign keys composed of
13751+
primary key attributes are considered. If False, return foreign keys including at least one
13752+
secondary attribute.</p>
1373613753
</div>
1373713754
</td>
1373813755
<td>
@@ -13787,7 +13804,8 @@ <h3 id="datajoint.Table.children" class="doc doc-heading">
1378713804
</td>
1378813805
<td>
1378913806
<div class="doc-md-description">
13790-
<p>list of children as table names or table objects with (optional) foreign key information.</p>
13807+
<p>list of children as table names or table objects
13808+
with (optional) foreign key information.</p>
1379113809
</div>
1379213810
</td>
1379313811
</tr>
@@ -14261,7 +14279,18 @@ <h3 id="datajoint.Table.update1" class="doc doc-heading">
1426114279
</td>
1426214280
<td>
1426314281
<div class="doc-md-description">
14264-
<p>a <code>dict</code> containing the primary key values and the attributes to update. Setting an attribute value to None will reset it to the default value (if any). The primary key attributes must always be provided. Examples: &gt;&gt;&gt; table.update1({'id': 1, 'value': 3}) # update value in record with id=1 &gt;&gt;&gt; table.update1({'id': 1, 'value': None}) # reset value to default</p>
14282+
<p>a <code>dict</code> containing the primary key values and the attributes to update.
14283+
Setting an attribute value to None will reset it to the default value (if any).</p>
14284+
<p>The primary key attributes must always be provided.</p>
14285+
<p>Examples:</p>
14286+
<blockquote>
14287+
<blockquote>
14288+
<blockquote>
14289+
<p>table.update1({'id': 1, 'value': 3}) # update value in record with id=1
14290+
table.update1({'id': 1, 'value': None}) # reset value to default</p>
14291+
</blockquote>
14292+
</blockquote>
14293+
</blockquote>
1426514294
</div>
1426614295
</td>
1426714296
<td>
@@ -14417,7 +14446,8 @@ <h3 id="datajoint.Table.insert1" class="doc doc-heading">
1441714446
</td>
1441814447
<td>
1441914448
<div class="doc-md-description">
14420-
<p>a numpy record, a dict-like object, or an ordered sequence to be inserted as one row.</p>
14449+
<p>a numpy record, a dict-like object, or an ordered sequence to be inserted
14450+
as one row.</p>
1442114451
</div>
1442214452
</td>
1442314453
<td>
@@ -14489,7 +14519,11 @@ <h3 id="datajoint.Table.insert" class="doc doc-heading">
1448914519
</td>
1449014520
<td>
1449114521
<div class="doc-md-description">
14492-
<p>Either (a) an iterable where an element is a numpy record, a dict-like object, a pandas.DataFrame, a sequence, or a query expression with the same heading as self, or (b) a pathlib.Path object specifying a path relative to the current directory with a CSV file, the contents of which will be inserted.</p>
14522+
<p>Either (a) an iterable where an element is a numpy record, a
14523+
dict-like object, a pandas.DataFrame, a sequence, or a query expression with
14524+
the same heading as self, or (b) a pathlib.Path object specifying a path
14525+
relative to the current directory with a CSV file, the contents of which
14526+
will be inserted.</p>
1449314527
</div>
1449414528
</td>
1449514529
<td>
@@ -14549,7 +14583,13 @@ <h3 id="datajoint.Table.insert" class="doc doc-heading">
1454914583
</td>
1455014584
<td>
1455114585
<div class="doc-md-description">
14552-
<p>Only applies in auto-populated tables. If False (default), insert may only be called from inside the make callback. Example: &gt;&gt;&gt; Table.insert([ &gt;&gt;&gt; dict(subject_id=7, species="mouse", date_of_birth="2014-09-01"), &gt;&gt;&gt; dict(subject_id=8, species="mouse", date_of_birth="2014-09-02")])</p>
14586+
<p>Only applies in auto-populated tables. If False (default),
14587+
insert may only be called from inside the make callback.</p>
14588+
<p>Example:</p>
14589+
<pre><code>&gt;&gt;&gt; Table.insert([
14590+
&gt;&gt;&gt; dict(subject_id=7, species="mouse", date_of_birth="2014-09-01"),
14591+
&gt;&gt;&gt; dict(subject_id=8, species="mouse", date_of_birth="2014-09-02")])
14592+
</code></pre>
1455314593
</div>
1455414594
</td>
1455514595
<td>

0.14/api/datajoint/admin/index.html

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3641,7 +3641,12 @@ <h2 id="datajoint.admin.kill" class="doc doc-heading">
36413641
</td>
36423642
<td>
36433643
<div class="doc-md-description">
3644-
<p>order by a single attribute or the list of attributes. defaults to 'id'. Restrictions are specified as strings and can involve any of the attributes of information_schema.processlist: ID, USER, HOST, DB, COMMAND, TIME, STATE, INFO. Examples: dj.kill('HOST LIKE "%compute%"') lists only connections from hosts containing "compute". dj.kill('TIME &gt; 600') lists only connections in their current state for more than 10 minutes</p>
3644+
<p>order by a single attribute or the list of attributes. defaults to 'id'.</p>
3645+
<p>Restrictions are specified as strings and can involve any of the attributes of
3646+
information_schema.processlist: ID, USER, HOST, DB, COMMAND, TIME, STATE, INFO.</p>
3647+
<p>Examples:
3648+
dj.kill('HOST LIKE "%compute%"') lists only connections from hosts containing "compute".
3649+
dj.kill('TIME &gt; 600') lists only connections in their current state for more than 10 minutes</p>
36453650
</div>
36463651
</td>
36473652
<td>
@@ -3826,7 +3831,11 @@ <h2 id="datajoint.admin.kill_quick" class="doc doc-heading">
38263831
</td>
38273832
<td>
38283833
<div class="doc-md-description">
3829-
<p>a datajoint.Connection object. Default calls datajoint.conn() Restrictions are specified as strings and can involve any of the attributes of information_schema.processlist: ID, USER, HOST, DB, COMMAND, TIME, STATE, INFO. Examples: dj.kill('HOST LIKE "%compute%"') terminates connections from hosts containing "compute".</p>
3834+
<p>a datajoint.Connection object. Default calls datajoint.conn()</p>
3835+
<p>Restrictions are specified as strings and can involve any of the attributes of
3836+
information_schema.processlist: ID, USER, HOST, DB, COMMAND, TIME, STATE, INFO.</p>
3837+
<p>Examples:
3838+
dj.kill('HOST LIKE "%compute%"') terminates connections from hosts containing "compute".</p>
38303839
</div>
38313840
</td>
38323841
<td>

0.14/api/datajoint/autopopulate/index.html

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4575,7 +4575,11 @@ <h3 id="datajoint.autopopulate.AutoPopulate.key_source" class="doc doc-heading">
45754575
</td>
45764576
<td>
45774577
<div class="doc-md-description">
4578-
<p>the query expression that yields primary key values to be passed, sequentially, to the <code>make</code> method when populate() is called. The default value is the join of the parent tables references from the primary key. Subclasses may override they key_source to change the scope or the granularity of the make calls.</p>
4578+
<p>the query expression that yields primary key values to be passed,
4579+
sequentially, to the <code>make</code> method when populate() is called.
4580+
The default value is the join of the parent tables references from the primary key.
4581+
Subclasses may override they key_source to change the scope or the granularity
4582+
of the make calls.</p>
45794583
</div>
45804584
</td>
45814585
</tr>
@@ -4674,7 +4678,8 @@ <h3 id="datajoint.autopopulate.AutoPopulate.make" class="doc doc-heading">
46744678
</td>
46754679
<td>
46764680
<div class="doc-md-description">
4677-
<p>Keyword arguments passed from populate(make_kwargs=...). These are passed to make_fetch for the tripartite pattern.</p>
4681+
<p>Keyword arguments passed from populate(make_kwargs=...).
4682+
These are passed to make_fetch for the tripartite pattern.</p>
46784683
</div>
46794684
</td>
46804685
<td>
@@ -4901,7 +4906,9 @@ <h3 id="datajoint.autopopulate.AutoPopulate.target" class="doc doc-heading">
49014906
</td>
49024907
<td>
49034908
<div class="doc-md-description">
4904-
<p>table to be populated. In the typical case, dj.AutoPopulate is mixed into a dj.Table class by inheritance and the target is self.</p>
4909+
<p>table to be populated.
4910+
In the typical case, dj.AutoPopulate is mixed into a dj.Table class by
4911+
inheritance and the target is self.</p>
49054912
</div>
49064913
</td>
49074914
</tr>
@@ -4951,7 +4958,8 @@ <h3 id="datajoint.autopopulate.AutoPopulate.populate" class="doc doc-heading">
49514958
</td>
49524959
<td>
49534960
<div class="doc-md-description">
4954-
<p>a list of restrictions each restrict (table.key_source - target.proj())</p>
4961+
<p>a list of restrictions each restrict
4962+
(table.key_source - target.proj())</p>
49554963
</div>
49564964
</td>
49574965
<td>
@@ -4966,7 +4974,8 @@ <h3 id="datajoint.autopopulate.AutoPopulate.populate" class="doc doc-heading">
49664974
</td>
49674975
<td>
49684976
<div class="doc-md-description">
4969-
<p>The list of keys (dicts) to send to self.make(). If None (default), then use self.key_source to query they keys.</p>
4977+
<p>The list of keys (dicts) to send to self.make().
4978+
If None (default), then use self.key_source to query they keys.</p>
49704979
</div>
49714980
</td>
49724981
<td>
@@ -5102,7 +5111,9 @@ <h3 id="datajoint.autopopulate.AutoPopulate.populate" class="doc doc-heading">
51025111
</td>
51035112
<td>
51045113
<div class="doc-md-description">
5105-
<p>Keyword arguments which do not affect the result of computation to be passed down to each <code>make()</code> call. Computation arguments should be specified within the pipeline e.g. using a <code>dj.Lookup</code> table.</p>
5114+
<p>Keyword arguments which do not affect the result of computation
5115+
to be passed down to each <code>make()</code> call. Computation arguments should be
5116+
specified within the pipeline e.g. using a <code>dj.Lookup</code> table.</p>
51065117
</div>
51075118
</td>
51085119
<td>
@@ -5127,7 +5138,9 @@ <h3 id="datajoint.autopopulate.AutoPopulate.populate" class="doc doc-heading">
51275138
</td>
51285139
<td>
51295140
<div class="doc-md-description">
5130-
<p>a dict with two keys "success_count": the count of successful <code>make()</code> calls in this <code>populate()</code> call "error_list": the error list that is filled if <code>suppress_errors</code> is True</p>
5141+
<p>a dict with two keys
5142+
"success_count": the count of successful <code>make()</code> calls in this <code>populate()</code> call
5143+
"error_list": the error list that is filled if <code>suppress_errors</code> is True</p>
51315144
</div>
51325145
</td>
51335146
</tr>

0.14/api/datajoint/condition/index.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4147,7 +4147,8 @@ <h2 id="datajoint.condition.make_condition" class="doc doc-heading">
41474147
</td>
41484148
<td>
41494149
<div class="doc-md-description">
4150-
<p>a set passed by reference to collect all column names used in the condition.</p>
4150+
<p>a set passed by reference to collect all column names used in the
4151+
condition.</p>
41514152
</div>
41524153
</td>
41534154
<td>
@@ -4589,7 +4590,8 @@ <h2 id="datajoint.condition.extract_column_names" class="doc doc-heading">
45894590
</td>
45904591
<td>
45914592
<div class="doc-md-description">
4592-
<p>set of extracted column names This may be MySQL-specific for now.</p>
4593+
<p>set of extracted column names
4594+
This may be MySQL-specific for now.</p>
45934595
</div>
45944596
</td>
45954597
</tr>

0.14/api/datajoint/connection/index.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4036,7 +4036,9 @@ <h2 id="datajoint.connection.conn" class="doc doc-heading">
40364036
</td>
40374037
<td>
40384038
<div class="doc-md-description">
4039-
<p>TLS encryption option. Valid options are: True (required), False (required no TLS), None (TLS preferred, default), dict (Manually specify values per <a href="https://dev.mysql.com/doc/refman/5.7/en/connection-options.html#encrypted-connection-options">https://dev.mysql.com/doc/refman/5.7/en/connection-options.html#encrypted-connection-options</a>).</p>
4039+
<p>TLS encryption option. Valid options are: True (required), False
4040+
(required no TLS), None (TLS preferred, default), dict (Manually specify values per
4041+
<a href="https://dev.mysql.com/doc/refman/5.7/en/connection-options.html#encrypted-connection-options">https://dev.mysql.com/doc/refman/5.7/en/connection-options.html#encrypted-connection-options</a>).</p>
40404042
</div>
40414043
</td>
40424044
<td>
@@ -5242,7 +5244,8 @@ <h3 id="datajoint.connection.Connection.query" class="doc doc-heading">
52425244
</td>
52435245
<td>
52445246
<div class="doc-md-description">
5245-
<p>If as_dict is set to True, the returned cursor objects returns query results as dictionary.</p>
5247+
<p>If as_dict is set to True, the returned cursor objects returns
5248+
query results as dictionary.</p>
52465249
</div>
52475250
</td>
52485251
<td>

0.14/api/datajoint/declare/index.html

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3797,7 +3797,8 @@ <h2 id="datajoint.declare.compile_foreign_key" class="doc doc-heading">
37973797
</td>
37983798
<td>
37993799
<div class="doc-md-description">
3800-
<p>None if the current foreign key is made from the dependent section. Otherwise it is the list of primary key attributes thus far -- to be updated by the function</p>
3800+
<p>None if the current foreign key is made from the dependent section. Otherwise it is the list
3801+
of primary key attributes thus far -- to be updated by the function</p>
38013802
</div>
38023803
</td>
38033804
<td>

0 commit comments

Comments
 (0)