Skip to content

Commit

Permalink
Update yard docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@bjkeller
bjkeller committed Sep 4, 2020
1 parent 40dc8c2 commit c843aee
Show file tree
Hide file tree
Showing 25 changed files with 1,256 additions and 768 deletions.
378 changes: 186 additions & 192 deletions docs/api/Collection.html
View file

Large diffs are not rendered by default.

409 changes: 407 additions & 2 deletions docs/api/DataAssociation.html
View file

Large diffs are not rendered by default.

118 changes: 57 additions & 61 deletions docs/api/DataAssociator.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/api/FieldType.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1608,7 +1608,7 @@ <h3 class="signature " id="type-instance_method">
</div>

<div id="footer">
Generated on Mon Jun 1 17:36:24 2020 by
Generated on Fri Sep 4 12:32:32 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/FieldValue.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2024,7 +2024,7 @@ <h3 class="signature " id="val-instance_method">
</div>

<div id="footer">
Generated on Mon Jun 1 17:36:24 2020 by
Generated on Fri Sep 4 12:32:32 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/FieldValueKrill.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -653,7 +653,7 @@ <h3 class="signature " id="retrieve-instance_method">
</div>

<div id="footer">
Generated on Mon Jun 1 17:36:21 2020 by
Generated on Fri Sep 4 12:32:30 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
Expand Down
127 changes: 94 additions & 33 deletions docs/api/Item.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -250,6 +250,28 @@ <h2>
<span class="summary_desc"><div class='inline'><p>scopes for searching Items.</p>
</div></span>

</li>


<li class="public ">
<span class="summary_signature">

<a href="#with_type-class_method" title="with_type (class method)">.<strong>with_type</strong>(object_type:) &#x21d2; Object </a>



</span>









<span class="summary_desc"><div class='inline'></div></span>

</li>


Expand Down Expand Up @@ -1006,10 +1028,6 @@ <h3 class="signature first" id="items_for-class_method">
<pre class="lines">


433
434
435
436
437
438
439
Expand All @@ -1019,10 +1037,14 @@ <h3 class="signature first" id="items_for-class_method">
443
444
445
446</pre>
446
447
448
449
450</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/models/item.rb', line 433</span>
<pre class="code"><span class="info file"># File 'app/models/item.rb', line 437</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_items_for'>items_for</span><span class='lparen'>(</span><span class='id identifier rubyid_sid'>sid</span><span class='comma'>,</span> <span class='id identifier rubyid_oid'>oid</span><span class='rparen'>)</span>
<span class='id identifier rubyid_sample'>sample</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Sample.html" title="Sample (class)">Sample</a></span></span><span class='period'>.</span><span class='id identifier rubyid_find_by'>find_by</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='id identifier rubyid_sid'>sid</span><span class='rparen'>)</span>
Expand Down Expand Up @@ -1181,16 +1203,16 @@ <h3 class="signature " id="new_object-class_method">
<pre class="lines">


388
389
390
391
392
393
394</pre>
394
395
396
397
398</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/models/item.rb', line 388</span>
<pre class="code"><span class="info file"># File 'app/models/item.rb', line 392</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new_object'>new_object</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
<span class='id identifier rubyid_olist'>olist</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="ObjectType.html" title="ObjectType (class)">ObjectType</a></span></span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>name = ?</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
Expand Down Expand Up @@ -1228,10 +1250,6 @@ <h3 class="signature " id="new_sample-class_method">
<pre class="lines">


396
397
398
399
400
401
402
Expand All @@ -1244,10 +1262,14 @@ <h3 class="signature " id="new_sample-class_method">
409
410
411
412</pre>
412
413
414
415
416</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/models/item.rb', line 396</span>
<pre class="code"><span class="info file"># File 'app/models/item.rb', line 400</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_new_sample'>new_sample</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='comma'>,</span> <span class='id identifier rubyid_spec'>spec</span><span class='rparen'>)</span>

Expand Down Expand Up @@ -1309,6 +1331,45 @@ <h3 class="signature " id="with_sample-class_method">
</td>
</tr>
</table>
</div>

<div class="method_details ">
<h3 class="signature " id="with_type-class_method">

.<strong>with_type</strong>(object_type:) &#x21d2; <tt>Object</tt>





</h3><div class="docstring">
<div class="discussion">


</div>
</div>
<div class="tags">


</div><table class="source_code">
<tr>
<td>
<pre class="lines">


384
385
386</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/models/item.rb', line 384</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_with_type'>with_type</span><span class='lparen'>(</span><span class='label'>object_type:</span><span class='rparen'>)</span>
<span class='id identifier rubyid_includes'>includes</span><span class='lparen'>(</span><span class='symbol'>:locator</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_includes'>includes</span><span class='lparen'>(</span><span class='symbol'>:object_type</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_where'>where</span><span class='lparen'>(</span><span class='label'>object_type:</span> <span class='id identifier rubyid_object_type'>object_type</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>

</div>
Expand Down Expand Up @@ -1682,19 +1743,19 @@ <h3 class="signature " id="export-instance_method">
<pre class="lines">


418
419
420
421
422
423
424
425
426
427</pre>
427
428
429
430
431</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/models/item.rb', line 418</span>
<pre class="code"><span class="info file"># File 'app/models/item.rb', line 422</span>

<span class='kw'>def</span> <span class='id identifier rubyid_export'>export</span>
<span class='id identifier rubyid_a'>a</span> <span class='op'>=</span> <span class='id identifier rubyid_attributes'>attributes</span>
Expand Down Expand Up @@ -2501,12 +2562,12 @@ <h3 class="signature " id="num_posts-instance_method">
<pre class="lines">


414
415
416</pre>
418
419
420</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/models/item.rb', line 414</span>
<pre class="code"><span class="info file"># File 'app/models/item.rb', line 418</span>

<span class='kw'>def</span> <span class='id identifier rubyid_num_posts'>num_posts</span>
<span class='id identifier rubyid_post_associations'>post_associations</span><span class='period'>.</span><span class='id identifier rubyid_count'>count</span>
Expand Down Expand Up @@ -3076,12 +3137,12 @@ <h3 class="signature " id="week-instance_method">
<pre class="lines">


429
430
431</pre>
433
434
435</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'app/models/item.rb', line 429</span>
<pre class="code"><span class="info file"># File 'app/models/item.rb', line 433</span>

<span class='kw'>def</span> <span class='id identifier rubyid_week'>week</span>
<span class='id identifier rubyid_created_at'>created_at</span><span class='period'>.</span><span class='id identifier rubyid_strftime'>strftime</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>%W</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
Expand All @@ -3096,7 +3157,7 @@ <h3 class="signature " id="week-instance_method">
</div>

<div id="footer">
Generated on Mon Jun 1 17:36:22 2020 by
Generated on Fri Sep 4 12:32:31 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/Job.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3014,7 +3014,7 @@ <h3 class="signature " id="submitter-instance_method">
</div>

<div id="footer">
Generated on Mon Jun 1 17:36:22 2020 by
Generated on Fri Sep 4 12:32:30 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/Krill/Base.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2890,7 +2890,7 @@ <h3 class="signature " id="transfer-instance_method">
</div>

<div id="footer">
Generated on Mon Jun 1 17:36:22 2020 by
Generated on Fri Sep 4 12:32:30 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/Krill/OperationList.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5036,7 +5036,7 @@ <h3 class="signature " id="validation_message-instance_method">
</div>

<div id="footer">
Generated on Mon Jun 1 17:36:22 2020 by
Generated on Fri Sep 4 12:32:30 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/Krill/ShowBlock.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1584,7 +1584,7 @@ <h3 class="signature " id="warning-instance_method">
</div>

<div id="footer">
Generated on Mon Jun 1 17:36:25 2020 by
Generated on Fri Sep 4 12:32:33 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/Krill/ShowResponse.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -624,7 +624,7 @@ <h3 class="signature " id="timestamp-instance_method">
</div>

<div id="footer">
Generated on Mon Jun 1 17:36:25 2020 by
Generated on Fri Sep 4 12:32:33 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/Krill/Table.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1648,7 +1648,7 @@ <h3 class="signature " id="to-instance_method">
</div>

<div id="footer">
Generated on Mon Jun 1 17:36:25 2020 by
Generated on Fri Sep 4 12:32:33 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/Locator.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -859,7 +859,7 @@ <h3 class="signature " id="to_s-instance_method">
</div>

<div id="footer">
Generated on Mon Jun 1 17:36:23 2020 by
Generated on Fri Sep 4 12:32:31 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/ObjectType.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1983,7 +1983,7 @@ <h3 class="signature " id="to_s-instance_method">
</div>

<div id="footer">
Generated on Mon Jun 1 17:36:24 2020 by
Generated on Fri Sep 4 12:32:32 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/Operation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3904,7 +3904,7 @@ <h3 class="signature " id="with_property-instance_method">
</div>

<div id="footer">
Generated on Mon Jun 1 17:36:23 2020 by
Generated on Fri Sep 4 12:32:31 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/api/OperationType.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1890,7 +1890,7 @@ <h3 class="signature " id="output-instance_method">
<pre class="code"><span class="info file"># File 'app/models/operation_type.rb', line 84</span>

<span class='kw'>def</span> <span class='id identifier rubyid_output'>output</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
<span class='id identifier rubyid_outputs'>outputs</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_field_type'>field_type</span><span class='op'>|</span> <span class='id identifier rubyid_field_type'>field_type</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_name'>name</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span>
<span class='id identifier rubyid_outputs'>outputs</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_field_type'>field_type</span><span class='op'>|</span> <span class='id identifier rubyid_field_type'>field_type</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>==</span> <span class='id identifier rubyid_name'>name</span> <span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='kw'>end</span></pre>
</td>
</tr>
Expand Down Expand Up @@ -2487,7 +2487,7 @@ <h3 class="signature " id="waiting-instance_method">
</div>

<div id="footer">
Generated on Mon Jun 1 17:36:25 2020 by
Generated on Fri Sep 4 12:32:33 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/Parameter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,7 @@ <h3 class="signature " id="make-class_method">
</div>

<div id="footer">
Generated on Mon Jun 1 17:36:23 2020 by
Generated on Fri Sep 4 12:32:31 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.25 (ruby-2.6.5).
</div>
Expand Down
Loading

0 comments on commit c843aee

Please sign in to comment.