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 17, 2023
1 parent 0f6f2d6 commit 2e9a77d
Show file tree
Hide file tree
Showing 16 changed files with 129 additions and 183 deletions.
52 changes: 13 additions & 39 deletions docs/Cask/Staged.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ <h2>
<li class="public ">
<span class="summary_signature">

<a href="#set_permissions-instance_method" title="#set_permissions (instance method)">#<strong>set_permissions</strong>(paths, permissions_str) &#x21d2; void </a>
<a href="#set_permissions-instance_method" title="#set_permissions (instance method)">#<strong>set_permissions</strong>(paths, permissions_str) &#x21d2; Object </a>


</span>
Expand Down Expand Up @@ -273,17 +273,17 @@ <h3 class="signature first" id="set_ownership-instance_method">
<pre class="lines">


23
24
25
26
27
28
29
30</pre>
30
31
32
33</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'cask/staged.rb', line 23</span>
<pre class="code"><span class="info file"># File 'cask/staged.rb', line 26</span>

<span class='kw'>def</span> <span class='id identifier rubyid_set_ownership'>set_ownership</span><span class='lparen'>(</span><span class='id identifier rubyid_paths'>paths</span><span class='comma'>,</span> <span class='label'>user:</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_must'>must</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../User.html" title="User (class)">User</a></span></span><span class='period'>.</span><span class='id identifier rubyid_current'><span class='object_link'><a href="../User.html#current-class_method" title="User.current (method)">current</a></span></span><span class='rparen'>)</span><span class='comma'>,</span> <span class='label'>group:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>staff</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_full_paths'>full_paths</span> <span class='op'>=</span> <span class='id identifier rubyid_remove_nonexistent'>remove_nonexistent</span><span class='lparen'>(</span><span class='id identifier rubyid_paths'>paths</span><span class='rparen'>)</span>
Expand All @@ -301,7 +301,7 @@ <h3 class="signature first" id="set_ownership-instance_method">
<div class="method_details ">
<h3 class="signature " id="set_permissions-instance_method">

#<strong>set_permissions</strong>(paths, permissions_str) &#x21d2; <tt>void</tt>
#<strong>set_permissions</strong>(paths, permissions_str) &#x21d2; <tt><span class='object_link'><a href="../Object.html" title="Object (class)">Object</a></span></tt>



Expand All @@ -314,56 +314,30 @@ <h3 class="signature " id="set_permissions-instance_method">
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 class="note returns_void">This method returns an undefined value.</p>



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

<li>

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


<span class='type'>(<tt><span class='object_link'><a href="#Paths-constant" title="Cask::Staged::Paths (constant)">Paths</a></span></tt>)</span>



</li>

<li>

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


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



</li>

</ul>


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


14
15
16
17
18
19
20</pre>
20
21
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'cask/staged.rb', line 14</span>
<pre class="code"><span class="info file"># File 'cask/staged.rb', line 17</span>

<span class='kw'>def</span> <span class='id identifier rubyid_set_permissions'>set_permissions</span><span class='lparen'>(</span><span class='id identifier rubyid_paths'>paths</span><span class='comma'>,</span> <span class='id identifier rubyid_permissions_str'>permissions_str</span><span class='rparen'>)</span>
<span class='id identifier rubyid_full_paths'>full_paths</span> <span class='op'>=</span> <span class='id identifier rubyid_remove_nonexistent'>remove_nonexistent</span><span class='lparen'>(</span><span class='id identifier rubyid_paths'>paths</span><span class='rparen'>)</span>
Expand Down
4 changes: 2 additions & 2 deletions docs/Commands.html
Original file line number Diff line number Diff line change
Expand Up @@ -1189,7 +1189,7 @@ <h3 class="signature " id="external_cmd_path-class_method">
<pre class="code"><span class="info file"># File 'commands.rb', line 86</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_external_cmd_path'>external_cmd_path</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rparen'>)</span>
<span class='id identifier rubyid_which'>which</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>brew-</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cmd'>cmd</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="PATH.html" title="PATH (class)">PATH</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="PATH.html#initialize-instance_method" title="PATH#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="ENV.html" title="ENV (class)">ENV</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PATH</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_append'>append</span><span class='lparen'>(</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_cmd_directories'><span class='object_link'><a href="Tap.html#cmd_directories-class_method" title="Tap.cmd_directories (method)">cmd_directories</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_which'>which</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>brew-</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cmd'>cmd</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="PATH.html" title="PATH (class)">PATH</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="PATH.html#initialize-instance_method" title="PATH#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="ENV.html" title="ENV (class)">ENV</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PATH</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_append'><span class='object_link'><a href="PATH.html#append-instance_method" title="PATH#append (method)">append</a></span></span><span class='lparen'>(</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_cmd_directories'><span class='object_link'><a href="Tap.html#cmd_directories-class_method" title="Tap.cmd_directories (method)">cmd_directories</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
Expand Down Expand Up @@ -1289,7 +1289,7 @@ <h3 class="signature " id="external_ruby_cmd_path-class_method">
<pre class="code"><span class="info file"># File 'commands.rb', line 82</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_external_ruby_cmd_path'>external_ruby_cmd_path</span><span class='lparen'>(</span><span class='id identifier rubyid_cmd'>cmd</span><span class='rparen'>)</span>
<span class='id identifier rubyid_which'>which</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>brew-</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cmd'>cmd</span><span class='embexpr_end'>}</span><span class='tstring_content'>.rb</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="PATH.html" title="PATH (class)">PATH</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="PATH.html#initialize-instance_method" title="PATH#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="ENV.html" title="ENV (class)">ENV</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PATH</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_append'>append</span><span class='lparen'>(</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_cmd_directories'><span class='object_link'><a href="Tap.html#cmd_directories-class_method" title="Tap.cmd_directories (method)">cmd_directories</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='id identifier rubyid_which'>which</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>brew-</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_cmd'>cmd</span><span class='embexpr_end'>}</span><span class='tstring_content'>.rb</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='const'><span class='object_link'><a href="PATH.html" title="PATH (class)">PATH</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="PATH.html#initialize-instance_method" title="PATH#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="ENV.html" title="ENV (class)">ENV</a></span></span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PATH</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_append'><span class='object_link'><a href="PATH.html#append-instance_method" title="PATH#append (method)">append</a></span></span><span class='lparen'>(</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_cmd_directories'><span class='object_link'><a href="Tap.html#cmd_directories-class_method" title="Tap.cmd_directories (method)">cmd_directories</a></span></span><span class='rparen'>)</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/GitHub/API.html
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ <h2>

</div>
</dt>
<dd><pre class="code"><span class='heredoc_beg'>&lt;&lt;~MESSAGE</span>
<dd><pre class="code"><span class='heredoc_beg'>&lt;&lt;~MESSAGE</span><span class='period'>.</span><span class='id identifier rubyid_freeze'>freeze</span>
<span class='tstring_content'> No GitHub credentials found in macOS Keychain, GitHub CLI or the environment.
</span><span class='tstring_content'> </span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="../GitHub.html" title="GitHub (module)">GitHub</a></span></span><span class='period'>.</span><span class='id identifier rubyid_pat_blurb'><span class='object_link'><a href="../GitHub.html#pat_blurb-class_method" title="GitHub.pat_blurb (method)">pat_blurb</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>
</span><span class='heredoc_end'>MESSAGE</span></pre></dd>
Expand Down
49 changes: 18 additions & 31 deletions docs/GitHubRunnerMatrix.html
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collaps
<li class="public ">
<span class="summary_signature">

<a href="#runners-instance_method" title="#runners (instance method)">#<strong>runners</strong> &#x21d2; Array&lt;GitHubRunner&gt; </a>
<a href="#runners-instance_method" title="#runners (instance method)">#<strong>runners</strong> &#x21d2; Object </a>


</span>
Expand All @@ -127,7 +127,7 @@ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collaps



<span class="summary_desc"><div class='inline'>
<span class="summary_desc"><div class='inline'><p>Returns the value of attribute runners.</p>
</div></span>

</li>
Expand Down Expand Up @@ -271,9 +271,6 @@ <h3 class="signature first" id="initialize-instance_method">
<pre class="lines">


40
41
42
43
44
45
Expand All @@ -285,10 +282,13 @@ <h3 class="signature first" id="initialize-instance_method">
51
52
53
54</pre>
54
55
56
57</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'github_runner_matrix.rb', line 40</span>
<pre class="code"><span class="info file"># File 'github_runner_matrix.rb', line 43</span>

<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_testing_formulae'>testing_formulae</span><span class='comma'>,</span> <span class='id identifier rubyid_deleted_formulae'>deleted_formulae</span><span class='comma'>,</span> <span class='label'>all_supported:</span><span class='comma'>,</span> <span class='label'>dependent_matrix:</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_all_supported'>all_supported</span> <span class='op'>&amp;&amp;</span> <span class='lparen'>(</span><span class='id identifier rubyid_testing_formulae'>testing_formulae</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span> <span class='op'>||</span> <span class='id identifier rubyid_deleted_formulae'>deleted_formulae</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span> <span class='op'>||</span> <span class='id identifier rubyid_dependent_matrix'>dependent_matrix</span><span class='rparen'>)</span>
Expand Down Expand Up @@ -320,47 +320,34 @@ <h2>Instance Attribute Details</h2>
<div class="method_details first">
<h3 class="signature first" id="runners-instance_method">

#<strong>runners</strong> &#x21d2; <tt><span class='object_link'><a href="Array.html" title="Array (class)">Array</a></span>&lt;<span class='object_link'><a href="GitHubRunner.html" title="GitHubRunner (class)">GitHubRunner</a></span>&gt;</tt> <span class="extras">(readonly)</span>
#<strong>runners</strong> &#x21d2; <tt><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></tt> <span class="extras">(readonly)</span>





</h3><div class="docstring">
<div class="discussion">

<p>Returns the value of attribute runners.</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="GitHubRunner.html" title="GitHubRunner (class)">GitHubRunner</a></span>&gt;</tt>)</span>



</li>

</ul>

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


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

<span class='kw'>def</span> <span class='id identifier rubyid_runners'>runners</span>
<span class='ivar'>@runners</span>
Expand Down Expand Up @@ -415,14 +402,14 @@ <h3 class="signature first" id="active_runner_specs_hash-instance_method">
<pre class="lines">


57
58
59
60
61</pre>
61
62
63
64</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'github_runner_matrix.rb', line 57</span>
<pre class="code"><span class="info file"># File 'github_runner_matrix.rb', line 60</span>

<span class='kw'>def</span> <span class='id identifier rubyid_active_runner_specs_hash'>active_runner_specs_hash</span>
<span class='id identifier rubyid_runners'>runners</span><span class='period'>.</span><span class='id identifier rubyid_select'>select</span><span class='lparen'>(</span><span class='op'>&amp;</span><span class='symbol'>:active</span><span class='rparen'>)</span>
Expand Down
Loading

0 comments on commit 2e9a77d

Please sign in to comment.