Skip to content

Commit

Permalink
[skip ci] Update documentation for v3.0.0-rc.1
Browse files Browse the repository at this point in the history
  • Loading branch information
floehopper committed Jan 24, 2025
1 parent 73b0e9a commit 09a5d9b
Show file tree
Hide file tree
Showing 52 changed files with 822 additions and 727 deletions.
13 changes: 6 additions & 7 deletions docs/Mocha.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha

&mdash; Mocha 2.7.1
&mdash; Mocha 3.0.0-rc.1

</title>

Expand Down Expand Up @@ -177,7 +177,6 @@ <h5 class="example_title"><div class='inline'>
<pre class="example code"><code><span class='const'><span class='object_link'><a href="" title="Mocha (module)">Mocha</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span>
<span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_stubbing_method_unnecessarily'>stubbing_method_unnecessarily</span> <span class='op'>=</span> <span class='symbol'>:prevent</span>
<span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_stubbing_method_on_non_mock_object'>stubbing_method_on_non_mock_object</span> <span class='op'>=</span> <span class='symbol'>:warn</span>
<span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_stubbing_method_on_nil'>stubbing_method_on_nil</span> <span class='op'>=</span> <span class='symbol'>:allow</span>
<span class='kw'>end</span></code></pre>

</div>
Expand Down Expand Up @@ -216,12 +215,12 @@ <h5 class="example_title"><div class='inline'>
<pre class="lines">


20
21
22</pre>
22
23</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mocha/configuration.rb', line 20</span>
<pre class="code"><span class="info file"># File 'lib/mocha/configuration.rb', line 21</span>

<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_configure'>configure</span>
<span class='kw'>yield</span> <span class='id identifier rubyid_configuration'>configuration</span>
Expand All @@ -236,9 +235,9 @@ <h5 class="example_title"><div class='inline'>
</div>

<div id="footer">
Generated on Mon Dec 9 12:52:24 2024 by
Generated on Fri Jan 24 15:05:27 2025 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.3.6).
0.9.37 (ruby-3.4.1).
</div>

</div>
Expand Down
46 changes: 23 additions & 23 deletions docs/Mocha/API.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha::API

&mdash; Mocha 2.7.1
&mdash; Mocha 3.0.0-rc.1

</title>

Expand Down Expand Up @@ -494,16 +494,16 @@ <h5 class="example_title"><div class='inline'>
<pre class="lines">


69
70
71
72
73
74
75</pre>
75
76
77</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mocha/api.rb', line 69</span>
<pre class="code"><span class="info file"># File 'lib/mocha/api.rb', line 71</span>

<span class='kw'>def</span> <span class='id identifier rubyid_mock'>mock</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_arguments'>arguments</span><span class='rparen'>)</span>
<span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='id identifier rubyid_arguments'>arguments</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>if</span> <span class='id identifier rubyid_arguments'>arguments</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_arguments'>arguments</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Symbol</span><span class='rparen'>)</span>
Expand Down Expand Up @@ -653,19 +653,19 @@ <h5 class="example_title"><div class='inline'>
<pre class="lines">


170
171
172
173
174
175
176
177
178
179</pre>
179
180
181</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mocha/api.rb', line 170</span>
<pre class="code"><span class="info file"># File 'lib/mocha/api.rb', line 172</span>

<span class='kw'>def</span> <span class='id identifier rubyid_sequence'>sequence</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
<span class='const'><span class='object_link'><a href="Sequence.html" title="Mocha::Sequence (class)">Sequence</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_tap'>tap</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_seq'>seq</span><span class='op'>|</span>
Expand Down Expand Up @@ -785,12 +785,12 @@ <h5 class="example_title"><div class='inline'>
<pre class="lines">


207
208
209</pre>
209
210
211</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mocha/api.rb', line 207</span>
<pre class="code"><span class="info file"># File 'lib/mocha/api.rb', line 209</span>

<span class='kw'>def</span> <span class='id identifier rubyid_states'>states</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
<span class='const'>Mockery</span><span class='period'>.</span><span class='id identifier rubyid_instance'>instance</span><span class='period'>.</span><span class='id identifier rubyid_new_state_machine'>new_state_machine</span><span class='lparen'>(</span><span class='id identifier rubyid_name'>name</span><span class='rparen'>)</span>
Expand Down Expand Up @@ -997,16 +997,16 @@ <h5 class="example_title"><div class='inline'>
<pre class="lines">


96
97
98
99
100
101
102</pre>
102
103
104</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mocha/api.rb', line 96</span>
<pre class="code"><span class="info file"># File 'lib/mocha/api.rb', line 98</span>

<span class='kw'>def</span> <span class='id identifier rubyid_stub'>stub</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_arguments'>arguments</span><span class='rparen'>)</span>
<span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='id identifier rubyid_arguments'>arguments</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span> <span class='kw'>if</span> <span class='id identifier rubyid_arguments'>arguments</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_arguments'>arguments</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Symbol</span><span class='rparen'>)</span>
Expand Down Expand Up @@ -1217,17 +1217,17 @@ <h5 class="example_title"><div class='inline'>
<pre class="lines">


123
124
125
126
127
128
129
130</pre>
130
131
132</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mocha/api.rb', line 123</span>
<pre class="code"><span class="info file"># File 'lib/mocha/api.rb', line 125</span>

<span class='kw'>def</span> <span class='id identifier rubyid_stub_everything'>stub_everything</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_arguments'>arguments</span><span class='rparen'>)</span>
<span class='id identifier rubyid_name'>name</span> <span class='op'>=</span> <span class='id identifier rubyid_arguments'>arguments</span><span class='period'>.</span><span class='id identifier rubyid_shift'>shift</span> <span class='kw'>if</span> <span class='id identifier rubyid_arguments'>arguments</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>String</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id identifier rubyid_arguments'>arguments</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Symbol</span><span class='rparen'>)</span>
Expand All @@ -1247,9 +1247,9 @@ <h5 class="example_title"><div class='inline'>
</div>

<div id="footer">
Generated on Mon Dec 9 12:52:24 2024 by
Generated on Fri Jan 24 15:05:27 2025 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.3.6).
0.9.37 (ruby-3.4.1).
</div>

</div>
Expand Down
16 changes: 9 additions & 7 deletions docs/Mocha/ClassMethods.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha::ClassMethods

&mdash; Mocha 2.7.1
&mdash; Mocha 3.0.0-rc.1

</title>

Expand Down Expand Up @@ -220,20 +220,22 @@ <h5 class="example_title"><div class='inline'>
<pre class="lines">


45
46
47
48
49
50</pre>
50
51
52
53</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/mocha/class_methods.rb', line 45</span>
<pre class="code"><span class="info file"># File 'lib/mocha/class_methods.rb', line 47</span>

<span class='kw'>def</span> <span class='id identifier rubyid_any_instance'>any_instance</span>
<span class='kw'>if</span> <span class='id identifier rubyid_frozen?'>frozen?</span>
<span class='id identifier rubyid_raise'>raise</span> <span class='const'><span class='object_link'><a href="StubbingError.html" title="Mocha::StubbingError (class)">StubbingError</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>can&#39;t stub method on frozen object: </span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_mocha_inspect'>mocha_inspect</span><span class='embexpr_end'>}</span><span class='tstring_content'>.any_instance</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='id identifier rubyid_caller'>caller</span><span class='rparen'>)</span>
<span class='kw'>end</span>

<span class='ivar'>@any_instance</span> <span class='op'>||=</span> <span class='const'>AnyInstance</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
Expand All @@ -246,9 +248,9 @@ <h5 class="example_title"><div class='inline'>
</div>

<div id="footer">
Generated on Mon Dec 9 12:52:24 2024 by
Generated on Fri Jan 24 15:05:27 2025 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.3.6).
0.9.37 (ruby-3.4.1).
</div>

</div>
Expand Down
Loading

0 comments on commit 09a5d9b

Please sign in to comment.