Skip to content

Commit

Permalink
docs: updates from Homebrew/brew
Browse files Browse the repository at this point in the history
  • Loading branch information
BrewTestBot committed Apr 21, 2024
1 parent 0b8b052 commit a9c5a37
Show file tree
Hide file tree
Showing 108 changed files with 3,901 additions and 3,085 deletions.
2 changes: 1 addition & 1 deletion docs/Cask/DSL/Version.html
Original file line number Diff line number Diff line change
Expand Up @@ -609,7 +609,7 @@ <h2>


<h3 class="inherited">Methods inherited from <span class='object_link'><a href="../../String.html" title="String (class)">String</a></span></h3>
<p class="inherited"><span class='object_link'><a href="../../String.html#blank%3F-instance_method" title="String#blank? (method)">#blank?</a></span>, <span class='object_link'><a href="../../String.html#c-instance_method" title="String#c (method)">#c</a></span>, <span class='object_link'><a href="../../String.html#exclude%3F-instance_method" title="String#exclude? (method)">#exclude?</a></span>, <span class='object_link'><a href="../../String.html#f-instance_method" title="String#f (method)">#f</a></span>, <span class='object_link'><a href="../../String.html#present%3F-instance_method" title="String#present? (method)">#present?</a></span></p>
<p class="inherited"><span class='object_link'><a href="../../String.html#blank%3F-instance_method" title="String#blank? (method)">#blank?</a></span>, <span class='object_link'><a href="../../String.html#exclude%3F-instance_method" title="String#exclude? (method)">#exclude?</a></span>, <span class='object_link'><a href="../../String.html#present%3F-instance_method" title="String#present? (method)">#present?</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>

Expand Down
137 changes: 94 additions & 43 deletions docs/Formatter.html
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,57 @@ <h2>Overview</h2><div class="docstring">


</div>

<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>

<dl class="constants">

<dt id="COMMAND_DESC_WIDTH-constant" class="">COMMAND_DESC_WIDTH =
<div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This constant is part of a private API.</strong>
This constant may only be used in the <a href="https://github.com/Homebrew/brew">Homebrew/brew</a> repository.
Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
</p>



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


</div>
</dt>
<dd><pre class="code"><span class='int'>80</span></pre></dd>

<dt id="OPTION_DESC_WIDTH-constant" class="">OPTION_DESC_WIDTH =
<div class="docstring">
<div class="discussion">
<p class="note private">
<strong>This constant is part of a private API.</strong>
This constant may only be used in the <a href="https://github.com/Homebrew/brew">Homebrew/brew</a> repository.
Third parties should avoid using this constant if possible, as it may be removed or changed without warning.
</p>



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


</div>
</dt>
<dd><pre class="code"><span class='int'>45</span></pre></dd>

</dl>





Expand Down Expand Up @@ -372,12 +423,12 @@ <h3 class="signature first" id="arrow-class_method">
<pre class="lines">


10
11
12</pre>
13
14
15</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 10</span>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 13</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_arrow'>arrow</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='comma'>,</span> <span class='label'>color:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_prefix'>prefix</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>==&gt;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_string'>string</span><span class='comma'>,</span> <span class='id identifier rubyid_color'>color</span><span class='rparen'>)</span>
Expand Down Expand Up @@ -417,9 +468,6 @@ <h3 class="signature " id="columns-class_method">
<pre class="lines">


84
85
86
87
88
89
Expand Down Expand Up @@ -458,10 +506,13 @@ <h3 class="signature " id="columns-class_method">
122
123
124
125</pre>
125
126
127
128</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 84</span>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 87</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_columns'>columns</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_objects'>objects</span><span class='comma'>,</span> <span class='label'>gap_size:</span> <span class='int'>2</span><span class='rparen'>)</span>
<span class='id identifier rubyid_objects'>objects</span> <span class='op'>=</span> <span class='id identifier rubyid_objects'>objects</span><span class='period'>.</span><span class='id identifier rubyid_flatten'>flatten</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:to_s</span><span class='rparen'>)</span>
Expand Down Expand Up @@ -540,12 +591,12 @@ <h3 class="signature " id="error-class_method">
<pre class="lines">


34
35
36</pre>
37
38
39</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 34</span>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 37</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_error'>error</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='comma'>,</span> <span class='label'>label:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_label'>label</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='comma'>,</span> <span class='id identifier rubyid_string'>string</span><span class='comma'>,</span> <span class='symbol'>:red</span><span class='rparen'>)</span>
Expand Down Expand Up @@ -606,21 +657,21 @@ <h3 class="signature " id="format_help_text-class_method">
<pre class="lines">


51
52
53
54
55
56
57
58
59</pre>
59
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 51</span>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 54</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_format_help_text'>format_help_text</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='comma'>,</span> <span class='label'>width:</span> <span class='int'>172</span><span class='rparen'>)</span>
<span class='id identifier rubyid_desc'>desc</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="top-level-namespace.html#OPTION_DESC_WIDTH-constant" title="OPTION_DESC_WIDTH (constant)">OPTION_DESC_WIDTH</a></span></span>
<span class='id identifier rubyid_desc'>desc</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="#OPTION_DESC_WIDTH-constant" title="Formatter::OPTION_DESC_WIDTH (constant)">OPTION_DESC_WIDTH</a></span></span>
<span class='id identifier rubyid_indent'>indent</span> <span class='op'>=</span> <span class='id identifier rubyid_width'>width</span> <span class='op'>-</span> <span class='id identifier rubyid_desc'>desc</span>
<span class='id identifier rubyid_string'>string</span><span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>(?&lt;=\S) *\n(?=\S)</span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='period'>.</span><span class='id identifier rubyid_gsub'>gsub</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>([`&gt;)\]]:) </span><span class='regexp_end'>/</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\\1\n </span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
Expand Down Expand Up @@ -663,12 +714,12 @@ <h3 class="signature " id="headline-class_method">
<pre class="lines">


14
15
16</pre>
17
18
19</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 14</span>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 17</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_headline'>headline</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='comma'>,</span> <span class='label'>color:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_arrow'>arrow</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="Tty.html" title="Tty (module)">Tty</a></span></span><span class='period'>.</span><span class='id identifier rubyid_bold'><span class='object_link'><a href="Tty.html#bold-class_method" title="Tty.bold (method)">bold</a></span></span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_string'>string</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="Tty.html" title="Tty (module)">Tty</a></span></span><span class='period'>.</span><span class='id identifier rubyid_reset'><span class='object_link'><a href="Tty.html#reset-class_method" title="Tty.reset (method)">reset</a></span></span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>color:</span><span class='rparen'>)</span>
Expand Down Expand Up @@ -708,12 +759,12 @@ <h3 class="signature " id="identifier-class_method">
<pre class="lines">


18
19
20</pre>
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 18</span>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 21</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_identifier'>identifier</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='rparen'>)</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="Tty.html" title="Tty (module)">Tty</a></span></span><span class='period'>.</span><span class='id identifier rubyid_green'><span class='object_link'><a href="Tty.html#green-class_method" title="Tty.green (method)">green</a></span></span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_string'>string</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="Tty.html" title="Tty (module)">Tty</a></span></span><span class='period'>.</span><span class='id identifier rubyid_default'><span class='object_link'><a href="Tty.html#default-class_method" title="Tty.default (method)">default</a></span></span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
Expand Down Expand Up @@ -753,12 +804,12 @@ <h3 class="signature " id="option-class_method">
<pre class="lines">


22
23
24</pre>
25
26
27</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 22</span>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 25</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_option'>option</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='rparen'>)</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="Tty.html" title="Tty (module)">Tty</a></span></span><span class='period'>.</span><span class='id identifier rubyid_bold'><span class='object_link'><a href="Tty.html#bold-class_method" title="Tty.bold (method)">bold</a></span></span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_string'>string</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="Tty.html" title="Tty (module)">Tty</a></span></span><span class='period'>.</span><span class='id identifier rubyid_reset'><span class='object_link'><a href="Tty.html#reset-class_method" title="Tty.reset (method)">reset</a></span></span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
Expand Down Expand Up @@ -798,12 +849,12 @@ <h3 class="signature " id="success-class_method">
<pre class="lines">


26
27
28</pre>
29
30
31</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 26</span>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 29</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_success'>success</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='comma'>,</span> <span class='label'>label:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_label'>label</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='comma'>,</span> <span class='id identifier rubyid_string'>string</span><span class='comma'>,</span> <span class='symbol'>:green</span><span class='rparen'>)</span>
Expand Down Expand Up @@ -843,12 +894,12 @@ <h3 class="signature " id="url-class_method">
<pre class="lines">


61
62
63</pre>
64
65
66</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 61</span>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 64</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='rparen'>)</span>
<span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="Tty.html" title="Tty (module)">Tty</a></span></span><span class='period'>.</span><span class='id identifier rubyid_underline'><span class='object_link'><a href="Tty.html#underline-class_method" title="Tty.underline (method)">underline</a></span></span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_string'>string</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="Tty.html" title="Tty (module)">Tty</a></span></span><span class='period'>.</span><span class='id identifier rubyid_no_underline'><span class='object_link'><a href="Tty.html#no_underline-class_method" title="Tty.no_underline (method)">no_underline</a></span></span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
Expand Down Expand Up @@ -888,12 +939,12 @@ <h3 class="signature " id="warning-class_method">
<pre class="lines">


30
31
32</pre>
33
34
35</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 30</span>
<pre class="code"><span class="info file"># File 'utils/formatter.rb', line 33</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_warning'>warning</span><span class='lparen'>(</span><span class='id identifier rubyid_string'>string</span><span class='comma'>,</span> <span class='label'>label:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_label'>label</span><span class='lparen'>(</span><span class='id identifier rubyid_label'>label</span><span class='comma'>,</span> <span class='id identifier rubyid_string'>string</span><span class='comma'>,</span> <span class='symbol'>:yellow</span><span class='rparen'>)</span>
Expand Down
Loading

0 comments on commit a9c5a37

Please sign in to comment.