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 Dec 13, 2023
1 parent bcb5d25 commit 13514a0
Show file tree
Hide file tree
Showing 6 changed files with 804 additions and 656 deletions.
2 changes: 1 addition & 1 deletion docs/Cask/Cask.html
Original file line number Diff line number Diff line change
Expand Up @@ -2143,7 +2143,7 @@ <h3 class="signature " id="full_name-instance_method">

<span class='kw'>def</span> <span class='id identifier rubyid_full_name'>full_name</span>
<span class='kw'>return</span> <span class='id identifier rubyid_token'>token</span> <span class='kw'>if</span> <span class='id identifier rubyid_tap'>tap</span><span class='period'>.</span><span class='id identifier rubyid_nil?'>nil?</span>
<span class='kw'>return</span> <span class='id identifier rubyid_token'>token</span> <span class='kw'>if</span> <span class='id identifier rubyid_tap'>tap</span><span class='period'>.</span><span class='id identifier rubyid_user'>user</span> <span class='op'>==</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Homebrew</span><span class='tstring_end'>&quot;</span></span>
<span class='kw'>return</span> <span class='id identifier rubyid_token'>token</span> <span class='kw'>if</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='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_tap'>tap</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</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='kw'>end</span></pre>
Expand Down
136 changes: 104 additions & 32 deletions docs/Cask/Caskroom.html
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,28 @@ <h2>
</li>



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

<a href="#tokens-class_method" title="tokens (class method)">.<strong>tokens</strong> &#x21d2; Array&lt;String&gt; </a>


</span>






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

<span class="summary_desc"><div class='inline'><p>Return all tokens for installed casks.</p>
</div></span>

</li>


</ul>


Expand Down Expand Up @@ -253,12 +275,12 @@ <h3 class="signature first" id="any_casks_installed?-class_method">
<pre class="lines">


26
27
28</pre>
32
33
34</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'cask/caskroom.rb', line 26</span>
<pre class="code"><span class="info file"># File 'cask/caskroom.rb', line 32</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_any_casks_installed?'>any_casks_installed?</span>
<span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_any?'>any?</span>
Expand Down Expand Up @@ -328,12 +350,6 @@ <h3 class="signature " id="casks-class_method">
<pre class="lines">


48
49
50
51
52
53
54
55
56
Expand All @@ -342,24 +358,22 @@ <h3 class="signature " id="casks-class_method">
59
60
61
62</pre>
62
63
64</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'cask/caskroom.rb', line 48</span>
<pre class="code"><span class="info file"># File 'cask/caskroom.rb', line 54</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_casks'>casks</span><span class='lparen'>(</span><span class='label'>config:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='id identifier rubyid_paths'>paths</span><span class='period'>.</span><span class='id identifier rubyid_sort'>sort</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_path'>path</span><span class='op'>|</span>
<span class='id identifier rubyid_token'>token</span> <span class='op'>=</span> <span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_basename'>basename</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>

<span class='kw'>begin</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_load'><span class='object_link'><a href="CaskLoader.html#load-class_method" title="Cask::CaskLoader.load (method)">load</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='label'>config:</span> <span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="TapCaskAmbiguityError.html" title="Cask::TapCaskAmbiguityError (class)">TapCaskAmbiguityError</a></span></span>
<span class='id identifier rubyid_tap_path'>tap_path</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_paths'><span class='object_link'><a href="CaskLoader.html#tap_paths-class_method" title="Cask::CaskLoader.tap_paths (method)">tap_paths</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='const'><span class='object_link'><a href="CaskLoader.html" title="Cask::CaskLoader (module)">CaskLoader</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="CaskLoader/FromTapPathLoader.html" title="Cask::CaskLoader::FromTapPathLoader (class)">FromTapPathLoader</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="CaskLoader/FromTapPathLoader.html#initialize-instance_method" title="Cask::CaskLoader::FromTapPathLoader#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_tap_path'>tap_path</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_load'><span class='object_link'><a href="CaskLoader/FromPathLoader.html#load-instance_method" title="Cask::CaskLoader::FromPathLoader#load (method)">load</a></span></span><span class='lparen'>(</span><span class='label'>config:</span> <span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="CaskUnavailableError.html" title="Cask::CaskUnavailableError (class)">CaskUnavailableError</a></span></span>
<span class='comment'># Don&#39;t blow up because of a single unavailable cask.
</span> <span class='kw'>nil</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_tokens'>tokens</span><span class='period'>.</span><span class='id identifier rubyid_sort'>sort</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_token'>token</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_load'><span class='object_link'><a href="CaskLoader.html#load-class_method" title="Cask::CaskLoader.load (method)">load</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='comma'>,</span> <span class='label'>config:</span> <span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
<span class='kw'>rescue</span> <span class='const'><span class='object_link'><a href="TapCaskAmbiguityError.html" title="Cask::TapCaskAmbiguityError (class)">TapCaskAmbiguityError</a></span></span>
<span class='id identifier rubyid_tap_path'>tap_path</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_paths'><span class='object_link'><a href="CaskLoader.html#tap_paths-class_method" title="Cask::CaskLoader.tap_paths (method)">tap_paths</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_token'>token</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
<span class='const'><span class='object_link'><a href="CaskLoader.html" title="Cask::CaskLoader (module)">CaskLoader</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="CaskLoader/FromTapPathLoader.html" title="Cask::CaskLoader::FromTapPathLoader (class)">FromTapPathLoader</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="CaskLoader/FromTapPathLoader.html#initialize-instance_method" title="Cask::CaskLoader::FromTapPathLoader#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_tap_path'>tap_path</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_load'><span class='object_link'><a href="CaskLoader/FromPathLoader.html#load-instance_method" title="Cask::CaskLoader::FromPathLoader#load (method)">load</a></span></span><span class='lparen'>(</span><span class='label'>config:</span> <span class='id identifier rubyid_config'>config</span><span class='rparen'>)</span>
<span class='kw'>rescue</span>
<span class='comment'># Don&#39;t blow up because of a single unavailable cask.
</span> <span class='kw'>nil</span>
<span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_compact'>compact</span>
<span class='kw'>end</span></pre>
</td>
Expand Down Expand Up @@ -397,12 +411,6 @@ <h3 class="signature " id="ensure_caskroom_exists-class_method">
<pre class="lines">


31
32
33
34
35
36
37
38
39
Expand All @@ -411,10 +419,16 @@ <h3 class="signature " id="ensure_caskroom_exists-class_method">
42
43
44
45</pre>
45
46
47
48
49
50
51</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'cask/caskroom.rb', line 31</span>
<pre class="code"><span class="info file"># File 'cask/caskroom.rb', line 37</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_ensure_caskroom_exists'>ensure_caskroom_exists</span>
<span class='kw'>return</span> <span class='kw'>if</span> <span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_exist?'>exist?</span>
Expand Down Expand Up @@ -492,6 +506,64 @@ <h3 class="signature " id="path-class_method">
</td>
</tr>
</table>
</div>

<div class="method_details ">
<h3 class="signature " id="tokens-class_method">

.<strong>tokens</strong> &#x21d2; <tt><span class='object_link'><a href="../Array.html" title="Array (class)">Array</a></span>&lt;<span class='object_link'><a href="../String.html" title="String (class)">String</a></span>&gt;</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>
<p>Return all tokens for installed casks.</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="../Array.html" title="Array (class)">Array</a></span>&lt;<span class='object_link'><a href="../String.html" title="String (class)">String</a></span>&gt;</tt>)</span>



</li>

</ul>

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


27
28
29</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'cask/caskroom.rb', line 27</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_tokens'>tokens</span>
<span class='id identifier rubyid_paths'>paths</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'>:basename</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'>:to_s</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>

</div>
Expand Down
Loading

0 comments on commit 13514a0

Please sign in to comment.