doc/String.html in doing-2.1.4pre vs doc/String.html in doing-2.1.5pre

- old
+ new

@@ -98,11 +98,11 @@ <dl> <dt>Defined in:</dt> <dd>lib/doing/string.rb<span class="defines">,<br /> - lib/doing/string_chronify.rb</span> + lib/doing/string_chronify.rb,<br /> lib/doing/template_string.rb</span> </dd> </dl> </div> @@ -114,13 +114,17 @@ </div> </div> <div class="tags"> +</div><div id="subclasses"> + <h2>Direct Known Subclasses</h2> + <p class="children"><span class='object_link'><a href="Doing/TemplateString.html" title="Doing::TemplateString (class)">Doing::TemplateString</a></span></p> </div> + <h2>Constant Summary</h2> <h3 class="inherited">Constants included from <span class='object_link'><a href="Doing/Color.html" title="Doing::Color (module)">Doing::Color</a></span></h3> <p class="inherited"><span class='object_link'><a href="Doing/Color.html#ATTRIBUTES-constant" title="Doing::Color::ATTRIBUTES (constant)">Doing::Color::ATTRIBUTES</a></span>, <span class='object_link'><a href="Doing/Color.html#ATTRIBUTE_NAMES-constant" title="Doing::Color::ATTRIBUTE_NAMES (constant)">Doing::Color::ATTRIBUTE_NAMES</a></span>, <span class='object_link'><a href="Doing/Color.html#COLORED_REGEXP-constant" title="Doing::Color::COLORED_REGEXP (constant)">Doing::Color::COLORED_REGEXP</a></span></p> @@ -386,11 +390,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#highlight_tags-instance_method" title="#highlight_tags (instance method)">#<strong>highlight_tags</strong>(color = &#39;yellow&#39;) &#x21d2; String </a> + <a href="#highlight_tags-instance_method" title="#highlight_tags (instance method)">#<strong>highlight_tags</strong>(color = &#39;yellow&#39;, last_color: nil) &#x21d2; String </a> </span> @@ -409,11 +413,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#highlight_tags!-instance_method" title="#highlight_tags! (instance method)">#<strong>highlight_tags!</strong>(color = &#39;yellow&#39;) &#x21d2; Object </a> + <a href="#highlight_tags!-instance_method" title="#highlight_tags! (instance method)">#<strong>highlight_tags!</strong>(color = &#39;yellow&#39;, last_color: nil) &#x21d2; Object </a> </span> @@ -635,10 +639,55 @@ <li class="public "> <span class="summary_signature"> + <a href="#normalize_matching-instance_method" title="#normalize_matching (instance method)">#<strong>normalize_matching</strong>(default = :pattern) &#x21d2; Object </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'></div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#normalize_matching!-instance_method" title="#normalize_matching! (instance method)">#<strong>normalize_matching!</strong>(default = :pattern) &#x21d2; Object </a> + + + + </span> + + + + + + + + + + <span class="summary_desc"><div class='inline'><p>Convert a matching configuration string to a symbol.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#normalize_order-instance_method" title="#normalize_order (instance method)">#<strong>normalize_order</strong>(default = &#39;asc&#39;) &#x21d2; Object </a> </span> @@ -882,11 +931,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#to_rx-instance_method" title="#to_rx (instance method)">#<strong>to_rx</strong>(distance: 3, case_type: :smart) &#x21d2; Regexp </a> + <a href="#to_rx-instance_method" title="#to_rx (instance method)">#<strong>to_rx</strong>(distance: nil, case_type: nil) &#x21d2; Regexp </a> </span> @@ -1085,10 +1134,33 @@ <li class="public "> <span class="summary_signature"> + <a href="#validate_color-instance_method" title="#validate_color (instance method)">#<strong>validate_color</strong> &#x21d2; String </a> + + + + </span> + + + + + + + <span class="private note title">private</span> + + + <span class="summary_desc"><div class='inline'><p>Extract the longest valid color from a string.</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#wildcard_to_rx-instance_method" title="#wildcard_to_rx (instance method)">#<strong>wildcard_to_rx</strong> &#x21d2; Object </a> </span> @@ -1107,11 +1179,11 @@ <li class="public "> <span class="summary_signature"> - <a href="#wrap-instance_method" title="#wrap (instance method)">#<strong>wrap</strong>(len, pad: 0, indent: &#39; &#39;, offset: 0, prefix: &#39;&#39;, color: &#39;&#39;, after: &#39;&#39;, reset: &#39;&#39;) &#x21d2; Object </a> + <a href="#wrap-instance_method" title="#wrap (instance method)">#<strong>wrap</strong>(len, pad: 0, indent: &#39; &#39;, offset: 0, prefix: &#39;&#39;, color: &#39;&#39;, after: &#39;&#39;, reset: &#39;&#39;, pad_first: false) &#x21d2; Object </a> </span> @@ -1488,11 +1560,11 @@ </div> <div class="method_details "> <h3 class="signature " id="highlight_tags-instance_method"> - #<strong>highlight_tags</strong>(color = &#39;yellow&#39;) &#x21d2; <tt><span class='object_link'><a href="" title="String (class)">String</a></span></tt> + #<strong>highlight_tags</strong>(color = &#39;yellow&#39;, last_color: nil) &#x21d2; <tt><span class='object_link'><a href="" title="String (class)">String</a></span></tt> @@ -1548,11 +1620,11 @@ </div> <div class="method_details "> <h3 class="signature " id="highlight_tags!-instance_method"> - #<strong>highlight_tags!</strong>(color = &#39;yellow&#39;) &#x21d2; <tt>Object</tt> + #<strong>highlight_tags!</strong>(color = &#39;yellow&#39;, last_color: nil) &#x21d2; <tt>Object</tt> @@ -1867,10 +1939,61 @@ </div> </div> <div class="method_details "> + <h3 class="signature " id="normalize_matching-instance_method"> + + #<strong>normalize_matching</strong>(default = :pattern) &#x21d2; <tt>Object</tt> + + + + + +</h3> +</div> + + <div class="method_details "> + <h3 class="signature " id="normalize_matching!-instance_method"> + + #<strong>normalize_matching!</strong>(default = :pattern) &#x21d2; <tt>Object</tt> + + + + + +</h3><div class="docstring"> + <div class="discussion"> + <p>Convert a matching configuration string to a symbol</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'></span> + + + + + <div class='inline'><p>Symbol :fuzzy, :pattern, :exact</p> +</div> + + </li> + +</ul> + +</div> +</div> + + <div class="method_details "> <h3 class="signature " id="normalize_order-instance_method"> #<strong>normalize_order</strong>(default = &#39;asc&#39;) &#x21d2; <tt>Object</tt> @@ -2213,11 +2336,11 @@ </div> <div class="method_details "> <h3 class="signature " id="to_rx-instance_method"> - #<strong>to_rx</strong>(distance: 3, case_type: :smart) &#x21d2; <tt>Regexp</tt> + #<strong>to_rx</strong>(distance: nil, case_type: nil) &#x21d2; <tt>Regexp</tt> @@ -2251,11 +2374,11 @@ <span class='type'>(<tt>Integer</tt>)</span> - <em class="default">(defaults to: <tt>3</tt>)</em> + <em class="default">(defaults to: <tt>nil</tt>)</em> &mdash; <div class='inline'><p>Allowed distance between characters</p> @@ -2269,11 +2392,11 @@ <span class='type'></span> - <em class="default">(defaults to: <tt>:smart</tt>)</em> + <em class="default">(defaults to: <tt>nil</tt>)</em> &mdash; <div class='inline'><p>The case type</p> </div> @@ -2527,10 +2650,57 @@ </h3> </div> <div class="method_details "> + <h3 class="signature " id="validate_color-instance_method"> + + #<strong>validate_color</strong> &#x21d2; <tt><span class='object_link'><a href="" title="String (class)">String</a></span></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>Extract the longest valid color from a string.</p> + +<p>Allows %colors to bleed into other text and still +be recognized, e.g. %greensomething still finds +%green.</p> + + + </div> +</div> +<div class="tags"> + +<p class="tag_title">Returns:</p> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="" title="String (class)">String</a></span></tt>)</span> + + + + &mdash; + <div class='inline'><p>a valid color name</p> +</div> + + </li> + +</ul> + +</div> +</div> + + <div class="method_details "> <h3 class="signature " id="wildcard_to_rx-instance_method"> #<strong>wildcard_to_rx</strong> &#x21d2; <tt>Object</tt> @@ -2541,11 +2711,11 @@ </div> <div class="method_details "> <h3 class="signature " id="wrap-instance_method"> - #<strong>wrap</strong>(len, pad: 0, indent: &#39; &#39;, offset: 0, prefix: &#39;&#39;, color: &#39;&#39;, after: &#39;&#39;, reset: &#39;&#39;) &#x21d2; <tt>Object</tt> + #<strong>wrap</strong>(len, pad: 0, indent: &#39; &#39;, offset: 0, prefix: &#39;&#39;, color: &#39;&#39;, after: &#39;&#39;, reset: &#39;&#39;, pad_first: false) &#x21d2; <tt>Object</tt> @@ -2618,10 +2788,10 @@ </div> </div> <div id="footer"> - Generated on Fri Dec 17 16:17:19 2021 by + Generated on Sun Dec 19 12:35:33 2021 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.26 (ruby-3.0.1). </div> </div> \ No newline at end of file