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 Mar 30, 2024
1 parent 1c38fa6 commit e6e9e1b
Show file tree
Hide file tree
Showing 8 changed files with 1,445 additions and 1,096 deletions.
8 changes: 1 addition & 7 deletions docs/Homebrew/DevCmd/Typecheck.html
Original file line number Diff line number Diff line change
Expand Up @@ -251,10 +251,7 @@ <h3 class="signature first" id="run-instance_method">
89
90
91
92
93
94
95</pre>
92</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'dev-cmd/typecheck.rb', line 42</span>
Expand All @@ -270,9 +267,6 @@ <h3 class="signature first" id="run-instance_method">
<span class='comment'># Prefer adding args here: Library/Homebrew/sorbet/tapioca/config.yml
</span> <span class='id identifier rubyid_tapioca_args'>tapioca_args</span> <span class='op'>=</span> <span class='id identifier rubyid_args'>args</span><span class='period'>.</span><span class='id identifier rubyid_update_all?'>update_all?</span> <span class='op'>?</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>--all</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span> <span class='op'>:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>

<span class='id identifier rubyid_ohai'>ohai</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Updating homegrown RBI files...</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_safe_system'>safe_system</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>bundle</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>exec</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>ruby</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>sorbet/custom_generators/env_config.rb</span><span class='tstring_end'>&quot;</span></span>

<span class='id identifier rubyid_ohai'>ohai</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Updating Tapioca RBI files...</span><span class='tstring_end'>&quot;</span></span>
<span class='id identifier rubyid_safe_system'>safe_system</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>bundle</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>exec</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>tapioca</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>gem</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='op'>*</span><span class='id identifier rubyid_tapioca_args'>tapioca_args</span>
<span class='id identifier rubyid_safe_system'>safe_system</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>bundle</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>exec</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>parlour</span><span class='tstring_end'>&quot;</span></span>
Expand Down
650 changes: 331 additions & 319 deletions docs/Homebrew/EnvConfig.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/Tapioca.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
<dl>
<dt>Defined in:</dt>
<dd>sorbet/tapioca/compilers/tty.rb<span class="defines">,<br />
sorbet/tapioca/compilers/args.rb,<br /> sorbet/tapioca/compilers/rubocop.rb</span>
sorbet/tapioca/compilers/args.rb,<br /> sorbet/tapioca/compilers/rubocop.rb,<br /> sorbet/tapioca/compilers/env_config.rb</span>
</dd>
</dl>

Expand Down
4 changes: 2 additions & 2 deletions docs/Tapioca/Compilers.html
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
<dl>
<dt>Defined in:</dt>
<dd>sorbet/tapioca/compilers/tty.rb<span class="defines">,<br />
sorbet/tapioca/compilers/args.rb,<br /> sorbet/tapioca/compilers/rubocop.rb</span>
sorbet/tapioca/compilers/args.rb,<br /> sorbet/tapioca/compilers/rubocop.rb,<br /> sorbet/tapioca/compilers/env_config.rb</span>
</dd>
</dl>

Expand All @@ -91,7 +91,7 @@ <h2>Defined Under Namespace</h2>



<strong class="classes">Classes:</strong> <span class='object_link'><a href="Compilers/Args.html" title="Tapioca::Compilers::Args (class)">Args</a></span>, <span class='object_link'><a href="Compilers/RuboCop.html" title="Tapioca::Compilers::RuboCop (class)">RuboCop</a></span>, <span class='object_link'><a href="Compilers/Tty.html" title="Tapioca::Compilers::Tty (class)">Tty</a></span>
<strong class="classes">Classes:</strong> <span class='object_link'><a href="Compilers/Args.html" title="Tapioca::Compilers::Args (class)">Args</a></span>, <span class='object_link'><a href="Compilers/EnvConfig.html" title="Tapioca::Compilers::EnvConfig (class)">EnvConfig</a></span>, <span class='object_link'><a href="Compilers/RuboCop.html" title="Tapioca::Compilers::RuboCop (class)">RuboCop</a></span>, <span class='object_link'><a href="Compilers/Tty.html" title="Tapioca::Compilers::Tty (class)">Tty</a></span>


</p>
Expand Down
320 changes: 320 additions & 0 deletions docs/Tapioca/Compilers/EnvConfig.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,320 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: Tapioca::Compilers::EnvConfig

&mdash; Homebrew Ruby API

</title>

<link rel="stylesheet" href="../../css/style.css" type="text/css" />

<link rel="stylesheet" href="../../css/common.css" type="text/css" />

<script type="text/javascript">
pathId = "Tapioca::Compilers::EnvConfig";
relpath = '../../';
</script>


<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>

<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>


</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>

<div id="main" tabindex="-1">
<div id="header">
<div id="menu">

<a href="../../_index.html">Index (E)</a> &raquo;
<span class='title'><span class='object_link'><a href="../../Tapioca.html" title="Tapioca (module)">Tapioca</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Compilers.html" title="Tapioca::Compilers (module)">Compilers</a></span></span>
&raquo;
<span class="title">EnvConfig</span>

</div>

<div id="search">

<a class="full_list_link" id="class_list_link"
href="../../class_list.html">

<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>

</div>
<div class="clear"></div>
</div>

<div id="content"><h1>Class: Tapioca::Compilers::EnvConfig



</h1>
<div class="box_info">

<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Dsl::Compiler</span>

<ul class="fullTree">
<li><span class='object_link'><a href="../../Object.html" title="Object (class)">Object</a></span></li>

<li class="next">Dsl::Compiler</li>

<li class="next">Tapioca::Compilers::EnvConfig</li>

</ul>
<a href="#" class="inheritanceTree">show all</a>

</dd>
</dl>











<dl>
<dt>Defined in:</dt>
<dd>sorbet/tapioca/compilers/env_config.rb</dd>
</dl>

</div>



<h2>
Constant Summary
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
</h2>

<dl class="constants">

<dt id="ConstantType-constant" class="">ConstantType =

</dt>
<dd><pre class="code"><span class='id identifier rubyid_type_member'>type_member</span> <span class='lbrace'>{</span> <span class='lbrace'>{</span> <span class='label'>fixed:</span> <span class='const'><span class='object_link'><a href="../../Module.html" title="Module (class)">Module</a></span></span> <span class='rbrace'>}</span> <span class='rbrace'>}</span></pre></dd>

</dl>









<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>

<ul class="summary">


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

<a href="#gather_constants-class_method" title="gather_constants (class method)">.<strong>gather_constants</strong> &#x21d2; Object </a>


</span>








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

</li>


</ul>

<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>

<ul class="summary">


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

<a href="#decorate-instance_method" title="#decorate (instance method)">#<strong>decorate</strong> &#x21d2; void </a>


</span>








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

</li>


</ul>





<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>


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

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





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


16</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'sorbet/tapioca/compilers/env_config.rb', line 16</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_gather_constants'>gather_constants</span> <span class='op'>=</span> <span class='lbracket'>[</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='rbracket'>]</span></pre>
</td>
</tr>
</table>
</div>

</div>

<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>


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

#<strong>decorate</strong> &#x21d2; <tt>void</tt>





</h3><div class="docstring">
<div class="discussion">
<p class="note returns_void">This method returns an undefined value.</p>


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


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


19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'sorbet/tapioca/compilers/env_config.rb', line 19</span>

<span class='kw'>def</span> <span class='id identifier rubyid_decorate'>decorate</span>
<span class='id identifier rubyid_root'><span class='object_link'><a href="../../top-level-namespace.html" title="Top Level Namespace (root)">root</a></span></span><span class='period'>.</span><span class='id identifier rubyid_create_module'>create_module</span><span class='lparen'>(</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_constant'>constant</span><span class='period'>.</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_mod'>mod</span><span class='op'>|</span>
<span class='id identifier rubyid_dynamic_methods'>dynamic_methods</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</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='op'>::</span><span class='const'><span class='object_link'><a href="../../Homebrew/EnvConfig.html#ENVS-constant" title="Homebrew::EnvConfig::ENVS (constant)">ENVS</a></span></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_env'>env</span><span class='comma'>,</span> <span class='id identifier rubyid_hash'>hash</span><span class='op'>|</span>
<span class='kw'>next</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='op'>::</span><span class='const'><span class='object_link'><a href="../../Homebrew/EnvConfig.html#CUSTOM_IMPLEMENTATIONS-constant" title="Homebrew::EnvConfig::CUSTOM_IMPLEMENTATIONS (constant)">CUSTOM_IMPLEMENTATIONS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='rparen'>)</span>

<span class='id identifier rubyid_name'>name</span> <span class='op'>=</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_env_method_name'><span class='object_link'><a href="../../Homebrew/EnvConfig.html#env_method_name-class_method" title="Homebrew::EnvConfig.env_method_name (method)">env_method_name</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_env'>env</span><span class='comma'>,</span> <span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
<span class='id identifier rubyid_dynamic_methods'>dynamic_methods</span><span class='lbracket'>[</span><span class='id identifier rubyid_name'>name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_hash'>hash</span><span class='lbracket'>[</span><span class='symbol'>:default</span><span class='rbracket'>]</span>
<span class='kw'>end</span>

<span class='id identifier rubyid_dynamic_methods'>dynamic_methods</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_method'>method</span><span class='comma'>,</span> <span class='id identifier rubyid_default'>default</span><span class='op'>|</span>
<span class='id identifier rubyid_return_type'>return_type</span> <span class='op'>=</span> <span class='kw'>if</span> <span class='id identifier rubyid_method'>method</span><span class='period'>.</span><span class='id identifier rubyid_end_with?'>end_with?</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>?</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
<span class='const'>T</span><span class='op'>::</span><span class='const'>Boolean</span>
<span class='kw'>elsif</span> <span class='id identifier rubyid_default'>default</span>
<span class='id identifier rubyid_default'>default</span><span class='period'>.</span><span class='id identifier rubyid_class'>class</span>
<span class='kw'>else</span>
<span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_nilable'>nilable</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../../String.html" title="String (class)">String</a></span></span><span class='rparen'>)</span>
<span class='kw'>end</span>

<span class='id identifier rubyid_mod'>mod</span><span class='period'>.</span><span class='id identifier rubyid_create_method'>create_method</span><span class='lparen'>(</span><span class='id identifier rubyid_method'>method</span><span class='comma'>,</span> <span class='label'>return_type:</span><span class='comma'>,</span> <span class='label'>class_method:</span> <span class='kw'>true</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>

</div>

</div>

<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>

</div>
</body>
</html>
7 changes: 7 additions & 0 deletions docs/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -1544,6 +1544,13 @@ <h2>Namespace Listing A-Z</h2>

</li>

<li>
<span class='object_link'><a href="Tapioca/Compilers/EnvConfig.html" title="Tapioca::Compilers::EnvConfig (class)">EnvConfig</a></span>

<small>(Tapioca::Compilers)</small>

</li>

<li>
<span class='object_link'><a href="Homebrew/EnvConfig.html" title="Homebrew::EnvConfig (module)">EnvConfig</a></span>

Expand Down
2 changes: 1 addition & 1 deletion docs/class_list.html

Large diffs are not rendered by default.

Loading

0 comments on commit e6e9e1b

Please sign in to comment.