Skip to content

Commit 0abfaff

Browse files
pbolingpboling
committed
📝 Documentation
1 parent 454a255 commit 0abfaff

21 files changed

+38
-23
lines changed

‎doc/SnakyHash.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ <h5 class="example_title"><div class='inline'><p>Usage with symbol keys and seri
147147
</div>
148148

149149
<div id="footer">
150-
Generated on Thu May 22 04:27:14 2025 by
150+
Generated on Thu May 22 06:18:36 2025 by
151151
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
152152
0.9.37 (ruby-3.4.3).
153153
</div>

‎doc/SnakyHash/Error.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ <h2>Overview</h2><div class="docstring">
124124
</div>
125125

126126
<div id="footer">
127-
Generated on Thu May 22 04:27:14 2025 by
127+
Generated on Thu May 22 06:18:36 2025 by
128128
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
129129
0.9.37 (ruby-3.4.3).
130130
</div>

‎doc/SnakyHash/Extensions.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -645,7 +645,7 @@ <h3 class="signature " id="run-instance_method">
645645
</div>
646646

647647
<div id="footer">
648-
Generated on Thu May 22 04:27:14 2025 by
648+
Generated on Thu May 22 06:18:36 2025 by
649649
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
650650
0.9.37 (ruby-3.4.3).
651651
</div>

‎doc/SnakyHash/Serializer.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -462,7 +462,7 @@ <h3 class="signature " id="load-instance_method">
462462
</div>
463463

464464
<div id="footer">
465-
Generated on Thu May 22 04:27:14 2025 by
465+
Generated on Thu May 22 06:18:36 2025 by
466466
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
467467
0.9.37 (ruby-3.4.3).
468468
</div>

‎doc/SnakyHash/Serializer/BackportedInstanceMethods.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ <h3 class="signature first" id="transform_values-instance_method">
254254
</div>
255255

256256
<div id="footer">
257-
Generated on Thu May 22 04:27:14 2025 by
257+
Generated on Thu May 22 06:18:36 2025 by
258258
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
259259
0.9.37 (ruby-3.4.3).
260260
</div>

‎doc/SnakyHash/Serializer/Modulizer.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -226,7 +226,7 @@ <h3 class="signature first" id="to_extended_mod-class_method">
226226
</div>
227227

228228
<div id="footer">
229-
Generated on Thu May 22 04:27:14 2025 by
229+
Generated on Thu May 22 06:18:36 2025 by
230230
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
231231
0.9.37 (ruby-3.4.3).
232232
</div>

‎doc/SnakyHash/Snake.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -376,7 +376,7 @@ <h3 class="signature first" id="included-instance_method">
376376
</div>
377377

378378
<div id="footer">
379-
Generated on Thu May 22 04:27:14 2025 by
379+
Generated on Thu May 22 06:18:36 2025 by
380380
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
381381
0.9.37 (ruby-3.4.3).
382382
</div>

‎doc/SnakyHash/Snake/SnakyModulizer.html‎

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,12 @@ <h3 class="signature first" id="to_mod-class_method">
275275
110
276276
111
277277
112
278-
113</pre>
278+
113
279+
114
280+
115
281+
116
282+
117
283+
118</pre>
279284
</td>
280285
<td>
281286
<pre class="code"><span class="info file"># File 'lib/snaky_hash/snake.rb', line 56</span>
@@ -284,7 +289,12 @@ <h3 class="signature first" id="to_mod-class_method">
284289
<span class='const'>Module</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span>
285290
<span class='kw'>case</span> <span class='id identifier rubyid_key_type'>key_type</span>
286291
<span class='kw'>when</span> <span class='symbol'>:string</span> <span class='kw'>then</span>
287-
<span class='comment'># Converts a key to a string if possible, after underscoring
292+
<span class='comment'># Converts a key to a string if it is symbolizable, after underscoring
293+
</span> <span class='comment'>#
294+
</span> <span class='comment'># @note checks for to_sym instead of to_s, because nearly everything responds_to?(:to_s)
295+
</span> <span class='comment'># so respond_to?(:to_s) isn&#39;t very useful as a test, and would result in symbolizing integers
296+
</span> <span class='comment'># amd it also provides parity between the :symbol behavior, and the :string behavior,
297+
</span> <span class='comment'># regarding which keys get converted for a given version of Ruby.
288298
</span> <span class='comment'>#
289299
</span> <span class='comment'># @param key [Object] the key to convert
290300
</span> <span class='comment'># @return [String, Object] the converted key or original if not convertible
@@ -348,7 +358,7 @@ <h3 class="signature first" id="to_mod-class_method">
348358
</div>
349359

350360
<div id="footer">
351-
Generated on Thu May 22 04:27:14 2025 by
361+
Generated on Thu May 22 06:18:36 2025 by
352362
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
353363
0.9.37 (ruby-3.4.3).
354364
</div>

‎doc/SnakyHash/StringKeyed.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ <h2>Overview</h2><div class="docstring">
130130
</div>
131131

132132
<div id="footer">
133-
Generated on Thu May 22 04:27:14 2025 by
133+
Generated on Thu May 22 06:18:36 2025 by
134134
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
135135
0.9.37 (ruby-3.4.3).
136136
</div>

‎doc/SnakyHash/SymbolKeyed.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ <h2>Overview</h2><div class="docstring">
130130
</div>
131131

132132
<div id="footer">
133-
Generated on Thu May 22 04:27:14 2025 by
133+
Generated on Thu May 22 06:18:36 2025 by
134134
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
135135
0.9.37 (ruby-3.4.3).
136136
</div>

0 commit comments

Comments
 (0)