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 May 10, 2024
1 parent 5c0e901 commit 88218c6
Show file tree
Hide file tree
Showing 3 changed files with 2,031 additions and 1,926 deletions.
191 changes: 144 additions & 47 deletions docs/CoreCaskTap.html
Original file line number Diff line number Diff line change
Expand Up @@ -265,6 +265,27 @@ <h2>



<span class="private note title">private</span>

<span class="summary_desc"><div class='inline'></div></span>

</li>



<li class="public ">
<span class="summary_signature">

<a href="#new_cask_font_path-instance_method" title="#new_cask_font_path (instance method)">#<strong>new_cask_font_path</strong>(token) &#x21d2; Pathname </a>


</span>






<span class="private note title">private</span>

<span class="summary_desc"><div class='inline'></div></span>
Expand Down Expand Up @@ -479,14 +500,14 @@ <h3 class="signature first" id="cask_files-instance_method">
<pre class="lines">


1405
1406
1407
1408
1409</pre>
1412
1413
1414
1415
1416</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'tap.rb', line 1405</span>
<pre class="code"><span class="info file"># File 'tap.rb', line 1412</span>

<span class='kw'>def</span> <span class='id identifier rubyid_cask_files'>cask_files</span>
<span class='kw'>return</span> <span class='kw'>super</span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="Homebrew.html" title="Homebrew (module)">Homebrew</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Homebrew/EnvConfig.html" title="Homebrew::EnvConfig (module)">EnvConfig</a></span></span><span class='period'>.</span><span class='id identifier rubyid_no_install_from_api?'><span class='object_link'><a href="Homebrew/EnvConfig.html#no_install_from_api%3F-class_method" title="Homebrew::EnvConfig.no_install_from_api? (method)">no_install_from_api?</a></span></span>
Expand Down Expand Up @@ -540,20 +561,20 @@ <h3 class="signature " id="cask_files_by_name-instance_method">
<pre class="lines">


1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429</pre>
1429
1430
1431
1432
1433
1434
1435
1436</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'tap.rb', line 1419</span>
<pre class="code"><span class="info file"># File 'tap.rb', line 1426</span>

<span class='kw'>def</span> <span class='id identifier rubyid_cask_files_by_name'>cask_files_by_name</span>
<span class='kw'>return</span> <span class='kw'>super</span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="Homebrew.html" title="Homebrew (module)">Homebrew</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Homebrew/EnvConfig.html" title="Homebrew::EnvConfig (module)">EnvConfig</a></span></span><span class='period'>.</span><span class='id identifier rubyid_no_install_from_api?'><span class='object_link'><a href="Homebrew/EnvConfig.html#no_install_from_api%3F-class_method" title="Homebrew::EnvConfig.no_install_from_api? (method)">no_install_from_api?</a></span></span>
Expand Down Expand Up @@ -613,16 +634,16 @@ <h3 class="signature " id="cask_renames-instance_method">
<pre class="lines">


1432
1433
1434
1435
1436
1437
1438</pre>
1439
1440
1441
1442
1443
1444
1445</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'tap.rb', line 1432</span>
<pre class="code"><span class="info file"># File 'tap.rb', line 1439</span>

<span class='kw'>def</span> <span class='id identifier rubyid_cask_renames'>cask_renames</span>
<span class='ivar'>@cask_renames</span> <span class='op'>||=</span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="Homebrew.html" title="Homebrew (module)">Homebrew</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Homebrew/EnvConfig.html" title="Homebrew::EnvConfig (module)">EnvConfig</a></span></span><span class='period'>.</span><span class='id identifier rubyid_no_install_from_api?'><span class='object_link'><a href="Homebrew/EnvConfig.html#no_install_from_api%3F-class_method" title="Homebrew::EnvConfig.no_install_from_api? (method)">no_install_from_api?</a></span></span>
Expand Down Expand Up @@ -678,14 +699,14 @@ <h3 class="signature " id="cask_tokens-instance_method">
<pre class="lines">


1412
1413
1414
1415
1416</pre>
1419
1420
1421
1422
1423</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'tap.rb', line 1412</span>
<pre class="code"><span class="info file"># File 'tap.rb', line 1419</span>

<span class='kw'>def</span> <span class='id identifier rubyid_cask_tokens'>cask_tokens</span>
<span class='kw'>return</span> <span class='kw'>super</span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="Homebrew.html" title="Homebrew (module)">Homebrew</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Homebrew/EnvConfig.html" title="Homebrew::EnvConfig (module)">EnvConfig</a></span></span><span class='period'>.</span><span class='id identifier rubyid_no_install_from_api?'><span class='object_link'><a href="Homebrew/EnvConfig.html#no_install_from_api%3F-class_method" title="Homebrew::EnvConfig.no_install_from_api? (method)">no_install_from_api?</a></span></span>
Expand Down Expand Up @@ -752,6 +773,82 @@ <h3 class="signature " id="core_cask_tap?-instance_method">
</td>
</tr>
</table>
</div>

<div class="method_details ">
<h3 class="signature " id="new_cask_font_path-instance_method">

#<strong>new_cask_font_path</strong>(token) &#x21d2; <tt><span class='object_link'><a href="Pathname.html" title="Pathname (class)">Pathname</a></span></tt>





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


</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">

<li>

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


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



</li>

</ul>

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

<li>


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



</li>

</ul>

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


1405
1406
1407
1408
1409</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'tap.rb', line 1405</span>

<span class='kw'>def</span> <span class='id identifier rubyid_new_cask_font_path'>new_cask_font_path</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='rparen'>)</span>
<span class='id identifier rubyid_font_first_letter'>font_first_letter</span> <span class='op'>=</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_must'>must</span><span class='lparen'>(</span><span class='id identifier rubyid_token'>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'>font-</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_second'>second</span><span class='rparen'>)</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
<span class='id identifier rubyid_cask_subdir'>cask_subdir</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>fonts/font-</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_font_first_letter'>font_first_letter</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_cask_dir'>cask_dir</span><span class='op'>/</span><span class='id identifier rubyid_cask_subdir'>cask_subdir</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='period'>.</span><span class='id identifier rubyid_downcase'>downcase</span><span class='embexpr_end'>}</span><span class='tstring_content'>.rb</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>

<div class="method_details ">
Expand Down Expand Up @@ -870,18 +967,18 @@ <h3 class="signature " id="tap_migrations-instance_method">
<pre class="lines">


1441
1442
1443
1444
1445
1446
1447
1448
1449</pre>
1449
1450
1451
1452
1453
1454
1455
1456</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'tap.rb', line 1441</span>
<pre class="code"><span class="info file"># File 'tap.rb', line 1448</span>

<span class='kw'>def</span> <span class='id identifier rubyid_tap_migrations'>tap_migrations</span>
<span class='ivar'>@tap_migrations</span> <span class='op'>||=</span> <span class='kw'>if</span> <span class='const'><span class='object_link'><a href="Homebrew.html" title="Homebrew (module)">Homebrew</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Homebrew/EnvConfig.html" title="Homebrew::EnvConfig (module)">EnvConfig</a></span></span><span class='period'>.</span><span class='id identifier rubyid_no_install_from_api?'><span class='object_link'><a href="Homebrew/EnvConfig.html#no_install_from_api%3F-class_method" title="Homebrew::EnvConfig.no_install_from_api? (method)">no_install_from_api?</a></span></span>
Expand Down Expand Up @@ -939,23 +1036,23 @@ <h3 class="signature " id="to_internal_api_hash-instance_method">
<pre class="lines">


1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465</pre>
1465
1466
1467
1468
1469
1470
1471
1472</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'tap.rb', line 1452</span>
<pre class="code"><span class="info file"># File 'tap.rb', line 1459</span>

<span class='kw'>def</span> <span class='id identifier rubyid_to_internal_api_hash'>to_internal_api_hash</span>
<span class='id identifier rubyid_casks_api_hash'>casks_api_hash</span> <span class='op'>=</span> <span class='id identifier rubyid_cask_tokens'>cask_tokens</span><span class='period'>.</span><span class='id identifier rubyid_to_h'>to_h</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_token'>token</span><span class='op'>|</span>
Expand Down
62 changes: 31 additions & 31 deletions docs/TapConfig.html
Original file line number Diff line number Diff line change
Expand Up @@ -296,12 +296,12 @@ <h3 class="signature first" id="initialize-instance_method">
<pre class="lines">


1474
1475
1476</pre>
1481
1482
1483</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'tap.rb', line 1474</span>
<pre class="code"><span class="info file"># File 'tap.rb', line 1481</span>

<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_tap'>tap</span><span class='rparen'>)</span>
<span class='ivar'>@tap</span> <span class='op'>=</span> <span class='id identifier rubyid_tap'>tap</span>
Expand Down Expand Up @@ -360,12 +360,12 @@ <h3 class="signature first" id="tap-instance_method">
<pre class="lines">


1471
1472
1473</pre>
1478
1479
1480</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'tap.rb', line 1471</span>
<pre class="code"><span class="info file"># File 'tap.rb', line 1478</span>

<span class='kw'>def</span> <span class='id identifier rubyid_tap'>tap</span>
<span class='ivar'>@tap</span>
Expand Down Expand Up @@ -439,18 +439,18 @@ <h3 class="signature first" id="[]-instance_method">
<pre class="lines">


1479
1480
1481
1482
1483
1484
1485
1486
1487</pre>
1487
1488
1489
1490
1491
1492
1493
1494</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'tap.rb', line 1479</span>
<pre class="code"><span class="info file"># File 'tap.rb', line 1486</span>

<span class='kw'>def</span> <span class='op'>[]</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_tap'>tap</span><span class='period'>.</span><span class='id identifier rubyid_git?'>git?</span>
Expand Down Expand Up @@ -521,15 +521,15 @@ <h3 class="signature " id="[]=-instance_method">
<pre class="lines">


1490
1491
1492
1493
1494
1495</pre>
1497
1498
1499
1500
1501
1502</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'tap.rb', line 1490</span>
<pre class="code"><span class="info file"># File 'tap.rb', line 1497</span>

<span class='kw'>def</span> <span class='op'>[]=</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_tap'>tap</span><span class='period'>.</span><span class='id identifier rubyid_git?'>git?</span>
Expand Down Expand Up @@ -586,15 +586,15 @@ <h3 class="signature " id="delete-instance_method">
<pre class="lines">


1498
1499
1500
1501
1502
1503</pre>
1505
1506
1507
1508
1509
1510</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'tap.rb', line 1498</span>
<pre class="code"><span class="info file"># File 'tap.rb', line 1505</span>

<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_tap'>tap</span><span class='period'>.</span><span class='id identifier rubyid_git?'>git?</span>
Expand Down
Loading

0 comments on commit 88218c6

Please sign in to comment.