docs: updates from Homebrew/brew

Homebrew · Mar 11, 2024 · 4edd18c · 4edd18c
1 parent 91515e1
commit 4edd18c
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 15 deletions.
diff --git a/docs/Cleaner.html b/docs/Cleaner.html
@@ -146,7 +146,7 @@ <h2>
 <li class="public ">
   <span class="summary_signature">
 
-      <a href="#clean-instance_method" title="#clean (instance method)">#<strong>clean</strong>  &#x21d2; Object </a>
+      <a href="#clean-instance_method" title="#clean (instance method)">#<strong>clean</strong>  &#x21d2; void </a>
 
 
   </span>
@@ -168,7 +168,7 @@ <h2>
 <li class="public ">
   <span class="summary_signature">
 
-      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(formula)  &#x21d2; Cleaner </a>
+      <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(formula)  &#x21d2; void </a>
 
 
   </span>
@@ -209,7 +209,7 @@ <h2>Constructor Details</h2>
     <div class="method_details first">
   <h3 class="signature first" id="initialize-instance_method">
 
-    #<strong>initialize</strong>(formula)  &#x21d2; <tt><span class='object_link'><a href="" title="Cleaner (class)">Cleaner</a></span></tt> 
+    #<strong>initialize</strong>(formula)  &#x21d2; <tt>void</tt> 
 
 
 
@@ -223,20 +223,35 @@ <h3 class="signature first" id="initialize-instance_method">
   </div>
 </div>
 <div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
 
+    <li>
+
+        <span class='name'>formula</span>
+
+
+        <span class='type'>(<tt><span class='object_link'><a href="Formula.html" title="Formula (class)">Formula</a></span></tt>)</span>
+
+
+
+    </li>
+
+</ul>
+
 
 </div><table class="source_code">
   <tr>
     <td>
       <pre class="lines">
 
 
-18
 19
-20</pre>
+20
+21</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'cleaner.rb', line 18</span>
+      <pre class="code"><span class="info file"># File 'cleaner.rb', line 19</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_formula'>formula</span><span class='rparen'>)</span>
   <span class='ivar'>@formula</span> <span class='op'>=</span> <span class='id identifier rubyid_formula'>formula</span>
@@ -256,15 +271,15 @@ <h2>Instance Method Details</h2>
       <div class="method_details first">
   <h3 class="signature first" id="clean-instance_method">
 
-    #<strong>clean</strong>  &#x21d2; <tt><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></tt> 
+    #<strong>clean</strong>  &#x21d2; <tt>void</tt> 
 
 
 
 
 
 </h3><div class="docstring">
   <div class="discussion">
-    <p>Clean the keg of the formula.</p>
+    <p class="note returns_void">This method returns an undefined value.</p><p>Clean the keg of the formula.</p>
 
 
   </div>
@@ -278,8 +293,6 @@ <h3 class="signature first" id="clean-instance_method">
       <pre class="lines">
 
 
-23
-24
 25
 26
 27
@@ -319,10 +332,11 @@ <h3 class="signature first" id="clean-instance_method">
 61
 62
 63
-64</pre>
+64
+65</pre>
     </td>
     <td>
-      <pre class="code"><span class="info file"># File 'cleaner.rb', line 23</span>
+      <pre class="code"><span class="info file"># File 'cleaner.rb', line 25</span>
 
 <span class='kw'>def</span> <span class='id identifier rubyid_clean'>clean</span>
   <span class='const'>ObserverPathnameExtension</span><span class='period'>.</span><span class='id identifier rubyid_reset_counts!'>reset_counts!</span>
@@ -352,8 +366,7 @@ <h3 class="signature first" id="clean-instance_method">
 </span>  <span class='comment'># [1]: https://github.com/Homebrew/brew/pull/11597
 </span>  <span class='comment'># [2]: https://github.com/Homebrew/homebrew-core/issues/100190
 </span>  <span class='comment'># [3]: https://github.com/Homebrew/brew/pull/13215
-</span>  <span class='const'>Dir</span><span class='period'>.</span><span class='id identifier rubyid_glob'>glob</span><span class='lparen'>(</span><span class='ivar'>@formula</span><span class='period'>.</span><span class='id identifier rubyid_info'>info</span><span class='op'>/</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>**/dir</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_file'>file</span><span class='op'>|</span>
-    <span class='id identifier rubyid_info_dir_file'>info_dir_file</span> <span class='op'>=</span> <span class='const'><span class='object_link'><a href="Pathname.html" title="Pathname (class)">Pathname</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_file'>file</span><span class='rparen'>)</span>
+</span>  <span class='ivar'>@formula</span><span class='period'>.</span><span class='id identifier rubyid_info'>info</span><span class='period'>.</span><span class='id identifier rubyid_glob'>glob</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>**/dir</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_info_dir_file'>info_dir_file</span><span class='op'>|</span>
     <span class='kw'>next</span> <span class='kw'>unless</span> <span class='id identifier rubyid_info_dir_file'>info_dir_file</span><span class='period'>.</span><span class='id identifier rubyid_file?'>file?</span>
     <span class='kw'>next</span> <span class='kw'>if</span> <span class='id identifier rubyid_info_dir_file'>info_dir_file</span> <span class='op'>==</span> <span class='ivar'>@formula</span><span class='period'>.</span><span class='id identifier rubyid_info'>info</span><span class='op'>/</span><span class='ivar'>@formula</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='op'>/</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>dir</span><span class='tstring_end'>&quot;</span></span>
     <span class='kw'>next</span> <span class='kw'>if</span> <span class='ivar'>@formula</span><span class='period'>.</span><span class='id identifier rubyid_skip_clean?'>skip_clean?</span><span class='lparen'>(</span><span class='id identifier rubyid_info_dir_file'>info_dir_file</span><span class='rparen'>)</span>

diff --git a/docs/FormulaInstaller.html b/docs/FormulaInstaller.html
@@ -3416,7 +3416,7 @@ <h3 class="signature " id="clean-instance_method">
 
 <span class='kw'>def</span> <span class='id identifier rubyid_clean'>clean</span>
   <span class='id identifier rubyid_ohai'>ohai</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Cleaning</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>if</span> <span class='id identifier rubyid_verbose?'>verbose?</span>
-  <span class='const'><span class='object_link'><a href="Cleaner.html" title="Cleaner (class)">Cleaner</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Cleaner.html#initialize-instance_method" title="Cleaner#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_formula'>formula</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_clean'><span class='object_link'><a href="Cleaner.html#clean-instance_method" title="Cleaner#clean (method)">clean</a></span></span>
+  <span class='const'><span class='object_link'><a href="Cleaner.html" title="Cleaner (class)">Cleaner</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Cleaner.html#initialize-instance_method" title="Cleaner#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_formula'>formula</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_clean'>clean</span>
 <span class='kw'>rescue</span> <span class='const'>Exception</span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span> <span class='comment'># rubocop:disable Lint/RescueException
 </span>  <span class='id identifier rubyid_opoo'>opoo</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>The cleaning step did not complete successfully</span><span class='tstring_end'>&quot;</span></span>
   <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Still, the installation was successful, so we will link it into your prefix.</span><span class='tstring_end'>&quot;</span></span>