doc/CSVDecision/Input.html in csv_decision-0.0.6 vs doc/CSVDecision/Input.html in csv_decision-0.0.7
- old
+ new
@@ -60,11 +60,11 @@
</div>
<div id="content"><h1>Module: CSVDecision::Input
-
+ <span class="private note title">Private</span>
</h1>
<div class="box_info">
@@ -83,11 +83,15 @@
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
-
+ <p class="note private">
+ <strong>This module is part of a private API.</strong>
+ You should avoid using this module if possible, as it may be removed or be changed in the future.
+</p>
+
<p>Parse the input hash.</p>
</div>
</div>
@@ -121,11 +125,11 @@
-
+ <span class="private note title">private</span>
<span class="summary_desc"><div class='inline'>
<p>Returns a hash of two hashes: * hash: either a copy with keys symbolized
or the original input object * scan_cols: Picks out the value in the input
@@ -145,19 +149,23 @@
<div class="method_details first">
<h3 class="signature first" id="parse-class_method">
- .<strong>parse</strong>(table:, input:, symbolize_keys:) ⇒ <tt>Hash{<span class='object_link'><a href="Symbol.html" title="CSVDecision::Symbol (module)">Symbol</a></span> => Hash{<span class='object_link'><a href="Symbol.html" title="CSVDecision::Symbol (module)">Symbol</a></span>=>Object}, Hash{Integer=>Object}}</tt>
+ .<strong>parse</strong>(table:, input:, symbolize_keys:) ⇒ <tt>Hash{Symbol => Hash{Symbol=>Object}, Hash{Integer=>Object}}</tt>
</h3><div class="docstring">
<div class="discussion">
-
+ <p class="note private">
+ <strong>This method is part of a private API.</strong>
+ You should avoid using this method if possible, as it may be removed or be changed in the future.
+</p>
+
<p>Returns a hash of two hashes:</p>
<ul><li>
<p>hash: either a copy with keys symbolized or the original input object</p>
</li><li>
<p>scan_cols: Picks out the value in the input hash for each table input
@@ -226,11 +234,11 @@
<ul class="return">
<li>
- <span class='type'>(<tt>Hash{<span class='object_link'><a href="Symbol.html" title="CSVDecision::Symbol (module)">Symbol</a></span> => Hash{<span class='object_link'><a href="Symbol.html" title="CSVDecision::Symbol (module)">Symbol</a></span>=>Object}, Hash{Integer=>Object}}</tt>)</span>
+ <span class='type'>(<tt>Hash{Symbol => Hash{Symbol=>Object}, Hash{Integer=>Object}}</tt>)</span>
—
<div class='inline'>
@@ -251,12 +259,10 @@
<tr>
<td>
<pre class="lines">
-15
-16
17
18
19
20
21
@@ -264,14 +270,16 @@
23
24
25
26
27
-28</pre>
+28
+29
+30</pre>
</td>
<td>
- <pre class="code"><span class="info file"># File 'lib/csv_decision/input.rb', line 15</span>
+ <pre class="code"><span class="info file"># File 'lib/csv_decision/input.rb', line 17</span>
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_parse'>parse</span><span class='lparen'>(</span><span class='label'>table:</span><span class='comma'>,</span> <span class='label'>input:</span><span class='comma'>,</span> <span class='label'>symbolize_keys:</span><span class='rparen'>)</span>
<span class='id identifier rubyid_validate'>validate</span><span class='lparen'>(</span><span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
<span class='comment'># For safety the default is to symbolize keys and make a copy of the hash.
@@ -281,11 +289,11 @@
<span class='id identifier rubyid_parsed_input'>parsed_input</span> <span class='op'>=</span> <span class='id identifier rubyid_parse_input'>parse_input</span><span class='lparen'>(</span><span class='label'>table:</span> <span class='id identifier rubyid_table'>table</span><span class='comma'>,</span> <span class='label'>input:</span> <span class='id identifier rubyid_input'>input</span><span class='rparen'>)</span>
<span class='comment'># Freeze the copy of the input hash we just created.
</span> <span class='id identifier rubyid_parsed_input'>parsed_input</span><span class='lbracket'>[</span><span class='symbol'>:hash</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span> <span class='kw'>if</span> <span class='id identifier rubyid_symbolize_keys'>symbolize_keys</span>
- <span class='id identifier rubyid_parsed_input'>parsed_input</span>
+ <span class='id identifier rubyid_parsed_input'>parsed_input</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
@@ -293,10 +301,10 @@
</div>
</div>
<div id="footer">
- Generated on Tue Dec 26 21:20:19 2017 by
+ Generated on Sat Dec 30 13:04:04 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.12 (ruby-2.3.0).
</div>
</div>
\ No newline at end of file