Skip to content

Commit

Permalink
[skip ci] Update documentation for v2.0.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
@floehopper
floehopper committed Nov 1, 2022
1 parent fcd5450 commit c5cf324
Show file tree
Hide file tree
Showing 50 changed files with 137 additions and 117 deletions.
4 changes: 2 additions & 2 deletions docs/Mocha.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -244,7 +244,7 @@ <h3 class="signature first" id="configure-class_method">
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:27 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/API.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha::API

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -1171,7 +1171,7 @@ <h3 class="signature " id="stub_everything-instance_method">
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:27 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/ClassMethods.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha::ClassMethods

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -254,7 +254,7 @@ <h3 class="signature first" id="any_instance-instance_method">
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:27 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
8 changes: 4 additions & 4 deletions docs/Mocha/Configuration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Class: Mocha::Configuration

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -568,11 +568,11 @@ <h3 class="signature " id="strict_keyword_argument_matching=-instance_method">

<p>Perform strict keyword argument comparison. Only supported in Ruby &gt;= v2.7.</p>

<p>When this option is set to <code>false</code> a positional <code>Hash</code> and a set of keyword arguments are treated the same during comparison, which can lead to false negatives in Ruby &gt;= v3.0 (see examples below). However, a deprecation warning will be displayed if a positional <code>Hash</code> matches a set of keyword arguments or vice versa. This is because <span class='object_link'><a href="#strict_keyword_argument_matching=-instance_method" title="Mocha::Configuration#strict_keyword_argument_matching= (method)">#strict_keyword_argument_matching=</a></span> will default to <code>true</code> in the future.</p>
<p>When this option is set to <code>false</code> a positional <code>Hash</code> and a set of keyword arguments are treated the same during comparison, which can lead to misleading passing tests in Ruby &gt;= v3.0 (see examples below). However, a deprecation warning will be displayed if a positional <code>Hash</code> matches a set of keyword arguments or vice versa. This is because <span class='object_link'><a href="#strict_keyword_argument_matching=-instance_method" title="Mocha::Configuration#strict_keyword_argument_matching= (method)">#strict_keyword_argument_matching=</a></span> will default to <code>true</code> in the future.</p>

<p>For more details on keyword arguments in Ruby v3, refer to <a href="https://www.ruby-lang.org/en/news/2019/12/12/separation-of-positional-and-keyword-arguments-in-ruby-3-0" target="_parent" title="this article">this article</a>.</p>

<p>Note that <code>Hash</code>-related matchers such as <span class='object_link'><a href="ParameterMatchers.html#has_value-instance_method" title="Mocha::ParameterMatchers#has_value (method)">ParameterMatchers#has_value</a></span> or <span class='object_link'><a href="ParameterMatchers.html#has_key-instance_method" title="Mocha::ParameterMatchers#has_key (method)">ParameterMatchers#has_key</a></span> will still treat a positional <code>Hash</code> and a set of keyword arguments the same, so false negatives are still possible when they are used.</p>
<p>Note that <code>Hash</code>-related matchers such as <span class='object_link'><a href="ParameterMatchers.html#has_value-instance_method" title="Mocha::ParameterMatchers#has_value (method)">ParameterMatchers#has_value</a></span> or <span class='object_link'><a href="ParameterMatchers.html#has_key-instance_method" title="Mocha::ParameterMatchers#has_key (method)">ParameterMatchers#has_key</a></span> will still treat a positional <code>Hash</code> and a set of keyword arguments the same, so misleading passing tests are still possible when they are used.</p>

<p>This configuration option is <code>false</code> by default to enable gradual adoption, but will be <code>true</code> by default in the future.</p>

Expand Down Expand Up @@ -1093,7 +1093,7 @@ <h3 class="signature " id="stubbing_non_public_method=-instance_method">
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:28 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/Expectation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Class: Mocha::Expectation

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -2911,7 +2911,7 @@ <h3 class="signature " id="yields-instance_method">
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:28 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/ExpectationError.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Exception: Mocha::ExpectationError

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -142,7 +142,7 @@ <h2>Overview</h2><div class="docstring">
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:28 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/ExpectationErrorFactory.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Class: Mocha::ExpectationErrorFactory

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -250,7 +250,7 @@ <h3 class="signature first" id="exception_class-class_method">
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:28 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/Hooks.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha::Hooks

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -360,7 +360,7 @@ <h3 class="signature " id="mocha_verify-instance_method">
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:27 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/Integration.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha::Integration

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -115,7 +115,7 @@ <h2>Defined Under Namespace</h2>
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:28 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/Integration/MiniTest.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha::Integration::MiniTest

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -113,7 +113,7 @@ <h2>Defined Under Namespace</h2>
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:28 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/Integration/MiniTest/Adapter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha::Integration::MiniTest::Adapter

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -154,7 +154,7 @@ <h3 class="inherited">Methods included from <span class='object_link'><a href=".
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:28 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/Integration/TestUnit.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha::Integration::TestUnit

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -113,7 +113,7 @@ <h2>Defined Under Namespace</h2>
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:28 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/Integration/TestUnit/Adapter.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha::Integration::TestUnit::Adapter

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -154,7 +154,7 @@ <h3 class="inherited">Methods included from <span class='object_link'><a href=".
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:28 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/Mock.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Class: Mocha::Mock

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -1131,7 +1131,7 @@ <h3 class="signature " id="unstub-instance_method">
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:28 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/ObjectMethods.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha::ObjectMethods

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -755,7 +755,7 @@ <h3 class="signature " id="unstub-instance_method">
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:27 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/ParameterMatchers.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Module: Mocha::ParameterMatchers

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -3054,7 +3054,7 @@ <h3 class="signature " id="yaml_equivalent-instance_method">
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:28 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/ParameterMatchers/AllOf.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Class: Mocha::ParameterMatchers::AllOf

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -143,7 +143,7 @@ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:28 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/ParameterMatchers/AnyOf.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Class: Mocha::ParameterMatchers::AnyOf

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -143,7 +143,7 @@ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:28 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/ParameterMatchers/AnyParameters.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Class: Mocha::ParameterMatchers::AnyParameters

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -143,7 +143,7 @@ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:28 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/ParameterMatchers/Anything.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Class: Mocha::ParameterMatchers::Anything

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -143,7 +143,7 @@ <h3 class="inherited">Methods inherited from <span class='object_link'><a href="
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:28 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/Mocha/ParameterMatchers/Base.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Class: Mocha::ParameterMatchers::Base

&mdash; Mocha 2.0.0.alpha.1
&mdash; Mocha 2.0.0

</title>

Expand Down Expand Up @@ -431,7 +431,7 @@ <h3 class="signature " id="|-instance_method">
</div>

<div id="footer">
Generated on Tue Oct 18 11:27:32 2022 by
Generated on Tue Nov 1 13:55:28 2022 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.1.0).
</div>
Expand Down
Loading

0 comments on commit c5cf324

Please sign in to comment.