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 17, 2024
1 parent c60e775 commit 74784c4
Show file tree
Hide file tree
Showing 4 changed files with 1,159 additions and 1,063 deletions.
4 changes: 2 additions & 2 deletions docs/Homebrew.html
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ <h2>

</div>
</dt>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>2.4.18</span><span class='tstring_end'>&quot;</span></span></pre></dd>
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>2.5.9</span><span class='tstring_end'>&quot;</span></span></pre></dd>

</dl>

Expand Down Expand Up @@ -2960,7 +2960,7 @@ <h3 class="signature " id="restore_backup-class_method">

<span class='kw'>return</span> <span class='kw'>unless</span> <span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_directory?'>directory?</span>

<span class='const'><span class='object_link'><a href="Pathname.html" title="Pathname (class)">Pathname</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_keg'>keg</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_rmtree'>rmtree</span> <span class='kw'>if</span> <span class='id identifier rubyid_keg'>keg</span><span class='period'>.</span><span class='id identifier rubyid_exist?'>exist?</span>
<span class='const'><span class='object_link'><a href="Pathname.html" title="Pathname (class)">Pathname</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_keg'>keg</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_rmtree'><span class='object_link'><a href="Pathname.html#rmtree-instance_method" title="Pathname#rmtree (method)">rmtree</a></span></span> <span class='kw'>if</span> <span class='id identifier rubyid_keg'>keg</span><span class='period'>.</span><span class='id identifier rubyid_exist?'>exist?</span>

<span class='id identifier rubyid_path'>path</span><span class='period'>.</span><span class='id identifier rubyid_rename'>rename</span> <span class='id identifier rubyid_keg'>keg</span>
<span class='id identifier rubyid_keg'>keg</span><span class='period'>.</span><span class='id identifier rubyid_link'>link</span><span class='lparen'>(</span><span class='label'>verbose:</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id identifier rubyid_keg_was_linked'>keg_was_linked</span>
Expand Down
70 changes: 69 additions & 1 deletion docs/Pathname.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
<dl>
<dt>Defined in:</dt>
<dd>extend/pathname.rb<span class="defines">,<br />
extend/os/mac/extend/pathname.rb,<br /> extend/os/linux/extend/pathname.rb,<br /> extend/os/mac/extend/pathname.rbi,<br /> extend/os/linux/extend/pathname.rbi</span>
extend/os/mac/extend/pathname.rb,<br /> extend/os/linux/extend/pathname.rb,<br /> extend/pathname/rmtree.rb,<br /> extend/os/mac/extend/pathname.rbi,<br /> extend/os/linux/extend/pathname.rbi</span>
</dd>
</dl>

Expand Down Expand Up @@ -585,6 +585,28 @@ <h2>



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

<a href="#rmtree-instance_method" title="#rmtree (instance method)">#<strong>rmtree</strong>(noop: nil, verbose: nil, secure: nil) &#x21d2; Object </a>


</span>








<span class="summary_desc"><div class='inline'><p>Like regular <code>rmtree</code>, except it never ignores errors.</p>
</div></span>

</li>



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

Expand Down Expand Up @@ -2325,6 +2347,52 @@ <h3 class="signature " id="rmdir_if_possible-instance_method">
</td>
</tr>
</table>
</div>

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

#<strong>rmtree</strong>(noop: nil, verbose: nil, secure: nil) &#x21d2; <tt><span class='object_link'><a href="Object.html" title="Object (class)">Object</a></span></tt>





</h3><div class="docstring">
<div class="discussion">
<p>Like regular <code>rmtree</code>, except it never ignores errors.</p>

<p>This was the default behaviour in Ruby 3.1 and earlier.</p>


</div>
</div>
<div class="tags">


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


10
11
12
13
14</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'extend/pathname/rmtree.rb', line 10</span>

<span class='kw'>def</span> <span class='id identifier rubyid_rmtree'>rmtree</span><span class='lparen'>(</span><span class='label'>noop:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>verbose:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>secure:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
<span class='comment'># odeprecated &quot;rmtree&quot;, &quot;FileUtils#rm_r&quot;
</span> <span class='const'>FileUtils</span><span class='period'>.</span><span class='id identifier rubyid_rm_r'>rm_r</span><span class='lparen'>(</span><span class='ivar'>@path</span><span class='comma'>,</span> <span class='label'>noop:</span><span class='comma'>,</span> <span class='label'>verbose:</span><span class='comma'>,</span> <span class='label'>secure:</span><span class='rparen'>)</span>
<span class='kw'>nil</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>

<div class="method_details ">
Expand Down
Loading

0 comments on commit 74784c4

Please sign in to comment.