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 Mar 1, 2024
1 parent f243a1c commit 07cee27
Show file tree
Hide file tree
Showing 15 changed files with 1,966 additions and 2,068 deletions.
36 changes: 18 additions & 18 deletions docs/AbstractCoreTap.html

Large diffs are not rendered by default.

101 changes: 73 additions & 28 deletions docs/Cask/CaskLoader.html
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ <h2>
<li class="public ">
<span class="summary_signature">

<a href="#tap_cask_token_type-class_method" title="tap_cask_token_type (class method)">.<strong>tap_cask_token_type</strong>(tapped_token, warn:) &#x21d2; Object </a>
<a href="#tap_cask_token_type-class_method" title="tap_cask_token_type (class method)">.<strong>tap_cask_token_type</strong>(tapped_token, warn:) &#x21d2; Array(String, Tap, [Symbol, nil])<sup>?</sup> </a>


</span>
Expand Down Expand Up @@ -313,12 +313,12 @@ <h3 class="signature first" id="default_path-class_method">
<pre class="lines">


584
585
586</pre>
589
590
591</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'cask/cask_loader.rb', line 584</span>
<pre class="code"><span class="info file"># File 'cask/cask_loader.rb', line 589</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_default_path'>default_path</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='rparen'>)</span>
<span class='id identifier rubyid_find_cask_in_tap'>find_cask_in_tap</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="../CoreCaskTap.html" title="CoreCaskTap (class)">CoreCaskTap</a></span></span><span class='period'>.</span><span class='id identifier rubyid_instance'><span class='object_link'><a href="../AbstractCoreTap.html#instance-class_method" title="AbstractCoreTap.instance (method)">instance</a></span></span><span class='rparen'>)</span>
Expand Down Expand Up @@ -358,21 +358,19 @@ <h3 class="signature " id="find_cask_in_tap-class_method">
<pre class="lines">


588
589
590
591
592
593</pre>
593
594
595
596
597</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'cask/cask_loader.rb', line 588</span>
<pre class="code"><span class="info file"># File 'cask/cask_loader.rb', line 593</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_find_cask_in_tap'>find_cask_in_tap</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_tap'>tap</span><span class='rparen'>)</span>
<span class='id identifier rubyid_filename'>filename</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_token'>token</span><span class='embexpr_end'>}</span><span class='tstring_content'>.rb</span><span class='tstring_end'>&quot;</span></span>

<span class='const'><span class='object_link'><a href="../Tap.html" title="Tap (class)">Tap</a></span></span><span class='period'>.</span><span class='id identifier rubyid_cask_files_by_name'><span class='object_link'><a href="../Tap.html#cask_files_by_name-class_method" title="Tap.cask_files_by_name (method)">cask_files_by_name</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_tap'>tap</span><span class='rparen'>)</span>
<span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_tap'>tap</span><span class='period'>.</span><span class='id identifier rubyid_cask_dir'>cask_dir</span><span class='op'>/</span><span class='id identifier rubyid_filename'>filename</span><span class='rparen'>)</span>
<span class='id identifier rubyid_tap'>tap</span><span class='period'>.</span><span class='id identifier rubyid_cask_files_by_name'>cask_files_by_name</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_tap'>tap</span><span class='period'>.</span><span class='id identifier rubyid_cask_dir'>cask_dir</span><span class='op'>/</span><span class='id identifier rubyid_filename'>filename</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
Expand Down Expand Up @@ -409,11 +407,6 @@ <h3 class="signature " id="for-class_method">
<pre class="lines">


564
565
566
567
568
569
570
571
Expand All @@ -427,10 +420,15 @@ <h3 class="signature " id="for-class_method">
579
580
581
582</pre>
582
583
584
585
586
587</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'cask/cask_loader.rb', line 564</span>
<pre class="code"><span class="info file"># File 'cask/cask_loader.rb', line 569</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='kw'>for</span><span class='lparen'>(</span><span class='id identifier rubyid_ref'>ref</span><span class='comma'>,</span> <span class='label'>need_path:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>warn:</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='lbracket'>[</span>
Expand Down Expand Up @@ -549,7 +547,7 @@ <h3 class="signature " id="path-class_method">
<div class="method_details ">
<h3 class="signature " id="tap_cask_token_type-class_method">

.<strong>tap_cask_token_type</strong>(tapped_token, warn:) &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>
.<strong>tap_cask_token_type</strong>(tapped_token, warn:) &#x21d2; <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span>(<span class='object_link'><a href="../String.html" title="String (class)">String</a></span>, <span class='object_link'><a href="../Tap.html" title="Tap (class)">Tap</a></span>, [<span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span>, nil])</tt><sup>?</sup>



Expand All @@ -568,15 +566,53 @@ <h3 class="signature " id="tap_cask_token_type-class_method">
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">

<li>

<span class='name'>tapped_token</span>


<span class='type'>(<tt><span class='object_link'><a href="../String.html" title="String (class)">String</a></span></tt>)</span>



</li>

<li>

<span class='name'>warn</span>


<span class='type'>(<tt>Boolean</tt>)</span>



</li>

</ul>

<p class="tag_title">Returns:</p>
<ul class="return">

<li>


<span class='type'>(<tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span>(<span class='object_link'><a href="../String.html" title="String (class)">String</a></span>, <span class='object_link'><a href="../Tap.html" title="Tap (class)">Tap</a></span>, [<span class='object_link'><a href="../Symbol.html" title="Symbol (class)">Symbol</a></span>, nil])</tt>, <tt>nil</tt>)</span>



</li>

</ul>

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


532
533
534
535
Expand Down Expand Up @@ -606,14 +642,21 @@ <h3 class="signature " id="tap_cask_token_type-class_method">
559
560
561
562</pre>
562
563
564
565
566
567</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'cask/cask_loader.rb', line 532</span>
<pre class="code"><span class="info file"># File 'cask/cask_loader.rb', line 533</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_tap_cask_token_type'>tap_cask_token_type</span><span class='lparen'>(</span><span class='id identifier rubyid_tapped_token'>tapped_token</span><span class='comma'>,</span> <span class='label'>warn:</span><span class='rparen'>)</span>
<span class='id identifier rubyid_user'>user</span><span class='comma'>,</span> <span class='id identifier rubyid_repo'>repo</span><span class='comma'>,</span> <span class='id identifier rubyid_token'>token</span> <span class='op'>=</span> <span class='id identifier rubyid_tapped_token'>tapped_token</span><span class='period'>.</span><span class='id identifier rubyid_split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>/</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='int'>3</span><span class='rparen'>)</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'>:downcase</span><span class='rparen'>)</span>
<span class='id identifier rubyid_tap'>tap</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Tap.html" title="Tap (class)">Tap</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fetch'><span class='object_link'><a href="../Tap.html#fetch-class_method" title="Tap.fetch (method)">fetch</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_user'>user</span><span class='comma'>,</span> <span class='id identifier rubyid_repo'>repo</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='id identifier rubyid_tap_with_token'>tap_with_token</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../Tap.html" title="Tap (class)">Tap</a></span></span><span class='period'>.</span><span class='id identifier rubyid_with_cask_token'>with_cask_token</span><span class='lparen'>(</span><span class='id identifier rubyid_tapped_token'>tapped_token</span><span class='rparen'>)</span><span class='rparen'>)</span>

<span class='id identifier rubyid_tap'>tap</span><span class='comma'>,</span> <span class='id identifier rubyid_token'>token</span> <span class='op'>=</span> <span class='id identifier rubyid_tap_with_token'>tap_with_token</span>

<span class='id identifier rubyid_type'>type</span> <span class='op'>=</span> <span class='kw'>nil</span>

<span class='kw'>if</span> <span class='lparen'>(</span><span class='id identifier rubyid_new_token'>new_token</span> <span class='op'>=</span> <span class='id identifier rubyid_tap'>tap</span><span class='period'>.</span><span class='id identifier rubyid_cask_renames'>cask_renames</span><span class='lbracket'>[</span><span class='id identifier rubyid_token'>token</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_presence'>presence</span><span class='rparen'>)</span>
Expand All @@ -632,7 +675,9 @@ <h3 class="signature " id="tap_cask_token_type-class_method">
<span class='id identifier rubyid_opoo'>opoo</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Tap migration for </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_tapped_token'>tapped_token</span><span class='embexpr_end'>}</span><span class='tstring_content'> points to itself, stopping recursion.</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>else</span>
<span class='id identifier rubyid_old_token'>old_token</span> <span class='op'>=</span> <span class='id identifier rubyid_tap'>tap</span><span class='period'>.</span><span class='id identifier rubyid_core_cask_tap?'>core_cask_tap?</span> <span class='op'>?</span> <span class='id identifier rubyid_token'>token</span> <span class='op'>:</span> <span class='id identifier rubyid_tapped_token'>tapped_token</span>
<span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_tap'>tap</span><span class='comma'>,</span> <span class='op'>=</span> <span class='id identifier rubyid_tap_cask_token_type'>tap_cask_token_type</span><span class='lparen'>(</span><span class='id identifier rubyid_new_tapped_token'>new_tapped_token</span><span class='comma'>,</span> <span class='label'>warn:</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='id identifier rubyid_token_tap_type'>token_tap_type</span> <span class='op'>=</span> <span class='id identifier rubyid_tap_cask_token_type'>tap_cask_token_type</span><span class='lparen'>(</span><span class='id identifier rubyid_new_tapped_token'>new_tapped_token</span><span class='comma'>,</span> <span class='label'>warn:</span> <span class='kw'>false</span><span class='rparen'>)</span><span class='rparen'>)</span>

<span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_tap'>tap</span><span class='comma'>,</span> <span class='op'>=</span> <span class='id identifier rubyid_token_tap_type'>token_tap_type</span>
<span class='id identifier rubyid_new_token'>new_token</span> <span class='op'>=</span> <span class='id identifier rubyid_new_tap'>new_tap</span><span class='period'>.</span><span class='id identifier rubyid_core_cask_tap?'>core_cask_tap?</span> <span class='op'>?</span> <span class='id identifier rubyid_token'>token</span> <span class='op'>:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_tap'>tap</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_token'>token</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_type'>type</span> <span class='op'>=</span> <span class='symbol'>:migration</span>
<span class='kw'>end</span>
Expand Down
4 changes: 2 additions & 2 deletions docs/Cask/CaskLoader/FromTapLoader.html
Original file line number Diff line number Diff line change
Expand Up @@ -506,9 +506,9 @@ <h3 class="signature first" id="try_new-class_method">
<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_try_new'>try_new</span><span class='lparen'>(</span><span class='id identifier rubyid_ref'>ref</span><span class='comma'>,</span> <span class='label'>warn:</span> <span class='kw'>false</span><span class='rparen'>)</span>
<span class='id identifier rubyid_ref'>ref</span> <span class='op'>=</span> <span class='id identifier rubyid_ref'>ref</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>

<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_ref'>ref</span><span class='period'>.</span><span class='id identifier rubyid_match?'>match?</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../top-level-namespace.html#HOMEBREW_TAP_CASK_REGEX-constant" title="HOMEBREW_TAP_CASK_REGEX (constant)">HOMEBREW_TAP_CASK_REGEX</a></span></span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='lparen'>(</span><span class='id identifier rubyid_token_tap_type'>token_tap_type</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../CaskLoader.html" title="Cask::CaskLoader (module)">CaskLoader</a></span></span><span class='period'>.</span><span class='id identifier rubyid_tap_cask_token_type'><span class='object_link'><a href="../CaskLoader.html#tap_cask_token_type-class_method" title="Cask::CaskLoader.tap_cask_token_type (method)">tap_cask_token_type</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_ref'>ref</span><span class='comma'>,</span> <span class='label'>warn:</span> <span class='id identifier rubyid_warn'>warn</span><span class='rparen'>)</span><span class='rparen'>)</span>

<span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_tap'>tap</span><span class='comma'>,</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="../CaskLoader.html" title="Cask::CaskLoader (module)">CaskLoader</a></span></span><span class='period'>.</span><span class='id identifier rubyid_tap_cask_token_type'><span class='object_link'><a href="../CaskLoader.html#tap_cask_token_type-class_method" title="Cask::CaskLoader.tap_cask_token_type (method)">tap_cask_token_type</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_ref'>ref</span><span class='comma'>,</span> <span class='label'>warn:</span> <span class='id identifier rubyid_warn'>warn</span><span class='rparen'>)</span>
<span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='id identifier rubyid_tap'>tap</span><span class='comma'>,</span> <span class='op'>=</span> <span class='id identifier rubyid_token_tap_type'>token_tap_type</span>
<span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_tap'>tap</span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_token'>token</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
Expand Down
Loading

0 comments on commit 07cee27

Please sign in to comment.