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 Jun 4, 2024
1 parent 5bdcbf8 commit 06909eb
Show file tree
Hide file tree
Showing 4 changed files with 5,067 additions and 4,961 deletions.
4 changes: 3 additions & 1 deletion docs/Cask/Cask.html
Original file line number Diff line number Diff line change
Expand Up @@ -5104,7 +5104,8 @@ <h3 class="signature " id="to_hash_with_variations-instance_method">
460
461
462
463</pre>
463
464</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'cask/cask.rb', line 423</span>
Expand All @@ -5129,6 +5130,7 @@ <h3 class="signature " id="to_hash_with_variations-instance_method">
<span class='const'><span class='object_link'><a href="../MacOSVersion.html" title="MacOSVersion (class)">MacOSVersion</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../MacOSVersion.html#SYMBOLS-constant" title="MacOSVersion::SYMBOLS (constant)">SYMBOLS</a></span></span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span><span class='period'>.</span><span class='id identifier rubyid_product'>product</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="../OnSystem.html" title="OnSystem (module)">OnSystem</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../OnSystem.html#ARCH_OPTIONS-constant" title="OnSystem::ARCH_OPTIONS (constant)">ARCH_OPTIONS</a></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_os'>os</span><span class='comma'>,</span> <span class='id identifier rubyid_arch'>arch</span><span class='op'>|</span>
<span class='id identifier rubyid_bottle_tag'>bottle_tag</span> <span class='op'>=</span> <span class='op'>::</span><span class='const'><span class='object_link'><a href="../Utils.html" title="Utils (module)">Utils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Utils/Bottles.html" title="Utils::Bottles (module)">Bottles</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Utils/Bottles/Tag.html" title="Utils::Bottles::Tag (class)">Tag</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Utils/Bottles/Tag.html#initialize-instance_method" title="Utils::Bottles::Tag#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>system:</span> <span class='id identifier rubyid_os'>os</span><span class='comma'>,</span> <span class='label'>arch:</span><span class='rparen'>)</span>
<span class='kw'>next</span> <span class='kw'>unless</span> <span class='id identifier rubyid_bottle_tag'>bottle_tag</span><span class='period'>.</span><span class='id identifier rubyid_valid_combination?'>valid_combination?</span>
<span class='kw'>next</span> <span class='kw'>if</span> <span class='id identifier rubyid_depends_on'>depends_on</span><span class='period'>.</span><span class='id identifier rubyid_macos'>macos</span> <span class='op'>&amp;&amp;</span> <span class='op'>!</span><span class='id identifier rubyid_depends_on'>depends_on</span><span class='period'>.</span><span class='id identifier rubyid_macos'>macos</span><span class='period'>.</span><span class='id identifier rubyid_allows?'>allows?</span><span class='lparen'>(</span><span class='id identifier rubyid_bottle_tag'>bottle_tag</span><span class='period'>.</span><span class='id identifier rubyid_to_macos_version'>to_macos_version</span><span class='rparen'>)</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/SimulateSystem.html" title="Homebrew::SimulateSystem (class)">SimulateSystem</a></span></span><span class='period'>.</span><span class='id identifier rubyid_with'><span class='object_link'><a href="../Homebrew/SimulateSystem.html#with-class_method" title="Homebrew::SimulateSystem.with (method)">with</a></span></span><span class='lparen'>(</span><span class='label'>os:</span><span class='comma'>,</span> <span class='label'>arch:</span><span class='rparen'>)</span> <span class='kw'>do</span>
<span class='id identifier rubyid_refresh'>refresh</span>
Expand Down
166 changes: 131 additions & 35 deletions docs/MacOSRequirement.html
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,27 @@ <h2>
<ul class="summary">


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

<a href="#allows%3F-instance_method" title="#allows? (instance method)">#<strong>allows?</strong>(other) &#x21d2; Boolean </a>


</span>






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

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

</li>



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

Expand Down Expand Up @@ -638,7 +659,82 @@ <h2>Instance Method Details</h2>


<div class="method_details first">
<h3 class="signature first" id="display_s-instance_method">
<h3 class="signature first" id="allows?-instance_method">

#<strong>allows?</strong>(other) &#x21d2; <tt>Boolean</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>


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

<p class="tag_title">Returns:</p>
<ul class="return">

<li>


<span class='type'>(<tt>Boolean</tt>)</span>



</li>

</ul>

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


64
65
66
67
68
69
70
71
72
73
74
75</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'requirements/macos_requirement.rb', line 64</span>

<span class='kw'>def</span> <span class='id identifier rubyid_allows?'>allows?</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='kw'>true</span> <span class='kw'>unless</span> <span class='id identifier rubyid_version_specified?'>version_specified?</span>

<span class='kw'>case</span> <span class='ivar'>@comparator</span>
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&gt;=</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>then</span> <span class='id identifier rubyid_other'>other</span> <span class='op'>&gt;=</span> <span class='ivar'>@version</span>
<span class='kw'>when</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>&lt;=</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>then</span> <span class='id identifier rubyid_other'>other</span> <span class='op'>&lt;=</span> <span class='ivar'>@version</span>
<span class='kw'>else</span>
<span class='kw'>return</span> <span class='ivar'>@version</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='ivar'>@version</span><span class='period'>.</span><span class='id identifier rubyid_respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:to_ary</span><span class='rparen'>)</span>

<span class='ivar'>@version</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>

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

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

Expand Down Expand Up @@ -679,20 +775,20 @@ <h3 class="signature first" id="display_s-instance_method">
<pre class="lines">


105
106
107
108
109
110
111
112
113
114
115</pre>
118
119
120
121
122
123
124
125
126
127
128</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'requirements/macos_requirement.rb', line 105</span>
<pre class="code"><span class="info file"># File 'requirements/macos_requirement.rb', line 118</span>

<span class='kw'>def</span> <span class='id identifier rubyid_display_s'>display_s</span>
<span class='kw'>if</span> <span class='id identifier rubyid_version_specified?'>version_specified?</span>
Expand Down Expand Up @@ -739,19 +835,6 @@ <h3 class="signature " id="message-instance_method">
<pre class="lines">


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
Expand All @@ -763,10 +846,23 @@ <h3 class="signature " id="message-instance_method">
85
86
87
88</pre>
88
89
90
91
92
93
94
95
96
97
98
99
100
101</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'requirements/macos_requirement.rb', line 64</span>
<pre class="code"><span class="info file"># File 'requirements/macos_requirement.rb', line 77</span>

<span class='kw'>def</span> <span class='id identifier rubyid_message'>message</span><span class='lparen'>(</span><span class='label'>type:</span> <span class='symbol'>:formula</span><span class='rparen'>)</span>
<span class='kw'>return</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>macOS is required for this software.</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>unless</span> <span class='id identifier rubyid_version_specified?'>version_specified?</span>
Expand Down Expand Up @@ -827,15 +923,15 @@ <h3 class="signature " id="to_json-instance_method">
<pre class="lines">


117
118
119
120
121
122</pre>
130
131
132
133
134
135</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'requirements/macos_requirement.rb', line 117</span>
<pre class="code"><span class="info file"># File 'requirements/macos_requirement.rb', line 130</span>

<span class='kw'>def</span> <span class='id identifier rubyid_to_json'>to_json</span><span class='lparen'>(</span><span class='id identifier rubyid_options'>options</span><span class='rparen'>)</span>
<span class='id identifier rubyid_comp'>comp</span> <span class='op'>=</span> <span class='ivar'>@comparator</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
Expand Down
38 changes: 19 additions & 19 deletions docs/MacOSVersion.html
Original file line number Diff line number Diff line change
Expand Up @@ -651,12 +651,12 @@ <h3 class="signature first" id="outdated_release?-instance_method">
<pre class="lines">


104
105
106</pre>
109
110
111</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'macos_version.rb', line 104</span>
<pre class="code"><span class="info file"># File 'macos_version.rb', line 109</span>

<span class='kw'>def</span> <span class='id identifier rubyid_outdated_release?'>outdated_release?</span>
<span class='kw'>self</span> <span class='op'>&lt;</span> <span class='const'><span class='object_link'><a href="top-level-namespace.html#HOMEBREW_MACOS_OLDEST_SUPPORTED-constant" title="HOMEBREW_MACOS_OLDEST_SUPPORTED (constant)">HOMEBREW_MACOS_OLDEST_SUPPORTED</a></span></span>
Expand Down Expand Up @@ -708,12 +708,12 @@ <h3 class="signature " id="prerelease?-instance_method">
<pre class="lines">


109
110
111</pre>
114
115
116</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'macos_version.rb', line 109</span>
<pre class="code"><span class="info file"># File 'macos_version.rb', line 114</span>

<span class='kw'>def</span> <span class='id identifier rubyid_prerelease?'>prerelease?</span>
<span class='kw'>self</span> <span class='op'>&gt;=</span> <span class='const'><span class='object_link'><a href="top-level-namespace.html#HOMEBREW_MACOS_NEWEST_UNSUPPORTED-constant" title="HOMEBREW_MACOS_NEWEST_UNSUPPORTED (constant)">HOMEBREW_MACOS_NEWEST_UNSUPPORTED</a></span></span>
Expand Down Expand Up @@ -851,18 +851,18 @@ <h3 class="signature " id="requires_nehalem_cpu?-instance_method">
<pre class="lines">


119
120
121
122
123
124
125
126
127</pre>
127
128
129
130
131
132</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'macos_version.rb', line 119</span>
<pre class="code"><span class="info file"># File 'macos_version.rb', line 124</span>

<span class='kw'>def</span> <span class='id identifier rubyid_requires_nehalem_cpu?'>requires_nehalem_cpu?</span>
<span class='kw'>return</span> <span class='kw'>false</span> <span class='kw'>if</span> <span class='id identifier rubyid_null?'>null?</span>
Expand Down Expand Up @@ -1060,12 +1060,12 @@ <h3 class="signature " id="unsupported_release?-instance_method">
<pre class="lines">


114
115
116</pre>
119
120
121</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'macos_version.rb', line 114</span>
<pre class="code"><span class="info file"># File 'macos_version.rb', line 119</span>

<span class='kw'>def</span> <span class='id identifier rubyid_unsupported_release?'>unsupported_release?</span>
<span class='id identifier rubyid_outdated_release?'>outdated_release?</span> <span class='op'>||</span> <span class='id identifier rubyid_prerelease?'>prerelease?</span>
Expand Down
Loading

0 comments on commit 06909eb

Please sign in to comment.