Skip to content

Commit

Permalink
Merge pull request #214 from rspec/update-rspec-core-docs
Browse files Browse the repository at this point in the history
Updated rspec-core docs from 3-13-maintenance
  • Loading branch information
JonRowe authored Oct 1, 2024
2 parents b11d350 + 7e4175f commit f4c7015
Show file tree
Hide file tree
Showing 69 changed files with 782 additions and 705 deletions.
12 changes: 6 additions & 6 deletions source/documentation/3.13/rspec-core/RSpec.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: RSpec
&mdash; Documentation by YARD 0.9.36
&mdash; Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/common.css" type="text/css" />
Expand Down Expand Up @@ -152,7 +152,7 @@ <h3 class="signature first" id="configuration-class_method">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='const'><span class='object_link'><a href="" title="RSpec (module)">RSpec</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configuration'>configuration</span><span class='period'>.</span><span class='id identifier rubyid_drb_port'>drb_port</span> <span class='op'>=</span> <span class='int'>1234</span></code></pre>
</div>
<p class="tag_title">See Also:</p>
Expand Down Expand Up @@ -257,7 +257,7 @@ <h3 class="signature " id="configure-class_method">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='const'><span class='object_link'><a href="" title="RSpec (module)">RSpec</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_config'>config</span><span class='op'>|</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_add_formatter'>add_formatter</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>documentation</span><span class='tstring_end'>&#39;</span></span>
<span class='kw'>end</span></code></pre>
Expand Down Expand Up @@ -305,7 +305,7 @@ <h3 class="signature " id="current_example-class_method">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code>
<span class='const'><span class='object_link'><a href="" title="RSpec (module)">RSpec</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'><span class='object_link'><a href="#configure-class_method" title="RSpec.configure (method)">configure</a></span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span>
<span class='comment'># context.example is deprecated, but RSpec.current_example is not
Expand Down Expand Up @@ -477,9 +477,9 @@ <h3 class="signature " id="reset-class_method">
</div>
</div>
<div id="footer">
Generated on Tue Sep 3 11:00:22 2024 by
Generated on Tue Oct 1 21:13:24 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-3.2.2).
0.9.37 (ruby-3.3.5).
</div>
</div>
</body>
Expand Down
6 changes: 3 additions & 3 deletions source/documentation/3.13/rspec-core/RSpec/Core.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: RSpec::Core
&mdash; Documentation by YARD 0.9.36
&mdash; Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/common.css" type="text/css" />
Expand Down Expand Up @@ -80,9 +80,9 @@ <h2>
</dl>
</div>
<div id="footer">
Generated on Tue Sep 3 11:00:22 2024 by
Generated on Tue Oct 1 21:13:24 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-3.2.2).
0.9.37 (ruby-3.3.5).
</div>
</div>
</body>
Expand Down
260 changes: 131 additions & 129 deletions source/documentation/3.13/rspec-core/RSpec/Core/Configuration.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: RSpec::Core::ConfigurationOptions
&mdash; Documentation by YARD 0.9.36
&mdash; Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/common.css" type="text/css" />
Expand Down Expand Up @@ -324,9 +324,9 @@ <h3 class="signature " id="configure_filter_manager-instance_method">
</div>
</div>
<div id="footer">
Generated on Tue Sep 3 11:00:23 2024 by
Generated on Tue Oct 1 21:13:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-3.2.2).
0.9.37 (ruby-3.3.5).
</div>
</div>
</body>
Expand Down
6 changes: 3 additions & 3 deletions source/documentation/3.13/rspec-core/RSpec/Core/DSL.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: RSpec::Core::DSL
&mdash; Documentation by YARD 0.9.36
&mdash; Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/common.css" type="text/css" />
Expand Down Expand Up @@ -184,9 +184,9 @@ <h3 class="signature " id="remove_globally!-class_method">
</div>
</div>
<div id="footer">
Generated on Tue Sep 3 11:00:22 2024 by
Generated on Tue Oct 1 21:13:24 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-3.2.2).
0.9.37 (ruby-3.3.5).
</div>
</div>
</body>
Expand Down
8 changes: 4 additions & 4 deletions source/documentation/3.13/rspec-core/RSpec/Core/Example.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: RSpec::Core::Example
&mdash; Documentation by YARD 0.9.36
&mdash; Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/common.css" type="text/css" />
Expand Down Expand Up @@ -83,7 +83,7 @@ <h2>Overview</h2><div class="docstring">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code>
<span class='const'><span class='object_link'><a href="../../RSpec.html" title="RSpec (module)">RSpec</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'><span class='object_link'><a href="../../RSpec.html#configure-class_method" title="RSpec.configure (method)">configure</a></span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_config'>config</span><span class='op'>|</span>
<span class='id identifier rubyid_config'>config</span><span class='period'>.</span><span class='id identifier rubyid_before'>before</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_example'>example</span><span class='op'>|</span>
Expand Down Expand Up @@ -1195,9 +1195,9 @@ <h3 class="signature " id="skipped?-instance_method">
</div>
</div>
<div id="footer">
Generated on Tue Sep 3 11:00:23 2024 by
Generated on Tue Oct 1 21:13:24 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-3.2.2).
0.9.37 (ruby-3.3.5).
</div>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: RSpec::Core::Example::ExecutionResult
&mdash; Documentation by YARD 0.9.36
&mdash; Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/common.css" type="text/css" />
Expand Down Expand Up @@ -604,9 +604,9 @@ <h3 class="signature " id="record_finished-instance_method">
</div>
</div>
<div id="footer">
Generated on Tue Sep 3 11:00:23 2024 by
Generated on Tue Oct 1 21:13:24 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-3.2.2).
0.9.37 (ruby-3.3.5).
</div>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: RSpec::Core::Example::Procsy
&mdash; Documentation by YARD 0.9.36
&mdash; Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/common.css" type="text/css" />
Expand Down Expand Up @@ -75,7 +75,7 @@ <h2>Overview</h2><div class="docstring">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code>
<span class='const'><span class='object_link'><a href="../../../RSpec.html" title="RSpec (module)">RSpec</a></span></span><span class='period'>.</span><span class='id identifier rubyid_configure'><span class='object_link'><a href="../../../RSpec.html#configure-class_method" title="RSpec.configure (method)">configure</a></span></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_around'>around</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_ex'>ex</span><span class='op'>|</span> <span class='comment'># Procsy which wraps the example
Expand Down Expand Up @@ -292,9 +292,9 @@ <h3 class="signature " id="to_proc-instance_method">
</div>
</div>
<div id="footer">
Generated on Tue Sep 3 11:00:23 2024 by
Generated on Tue Oct 1 21:13:24 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-3.2.2).
0.9.37 (ruby-3.3.5).
</div>
</div>
</body>
Expand Down
32 changes: 16 additions & 16 deletions source/documentation/3.13/rspec-core/RSpec/Core/ExampleGroup.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: RSpec::Core::ExampleGroup
&mdash; Documentation by YARD 0.9.36
&mdash; Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/common.css" type="text/css" />
Expand Down Expand Up @@ -412,7 +412,7 @@ <h3 class="signature " id="example-class_method">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='id identifier rubyid_example'>example</span> <span class='kw'>do</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_example'>example</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>does something</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
Expand Down Expand Up @@ -543,7 +543,7 @@ <h3 class="signature " id="fexample-class_method">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='id identifier rubyid_fexample'>fexample</span> <span class='kw'>do</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_fexample'>fexample</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>does something</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
Expand Down Expand Up @@ -678,7 +678,7 @@ <h3 class="signature " id="fit-class_method">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='id identifier rubyid_fit'>fit</span> <span class='kw'>do</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_fit'>fit</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>does something</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
Expand Down Expand Up @@ -813,7 +813,7 @@ <h3 class="signature " id="focus-class_method">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='id identifier rubyid_focus'>focus</span> <span class='kw'>do</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_focus'>focus</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>does something</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
Expand Down Expand Up @@ -948,7 +948,7 @@ <h3 class="signature " id="fspecify-class_method">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='id identifier rubyid_fspecify'>fspecify</span> <span class='kw'>do</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_fspecify'>fspecify</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>does something</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
Expand Down Expand Up @@ -1187,7 +1187,7 @@ <h3 class="signature " id="it-class_method">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='id identifier rubyid_it'>it</span> <span class='kw'>do</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>does something</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
Expand Down Expand Up @@ -1348,7 +1348,7 @@ <h3 class="signature " id="pending-class_method">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='id identifier rubyid_pending'>pending</span> <span class='kw'>do</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_pending'>pending</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>does something</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
Expand Down Expand Up @@ -1578,7 +1578,7 @@ <h3 class="signature " id="skip-class_method">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='id identifier rubyid_skip'>skip</span> <span class='kw'>do</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_skip'>skip</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>does something</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
Expand Down Expand Up @@ -1714,7 +1714,7 @@ <h3 class="signature " id="specify-class_method">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='const'><span class='object_link'><a href="../../RSpec.html" title="RSpec (module)">RSpec</a></span></span><span class='period'>.</span><span class='id identifier rubyid_describe'>describe</span> <span class='const'>MyClass</span> <span class='kw'>do</span>
<span class='id identifier rubyid_specify'>specify</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>#do_something is deprecated</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='comment'># ...
Expand Down Expand Up @@ -1850,7 +1850,7 @@ <h3 class="signature " id="xexample-class_method">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='id identifier rubyid_xexample'>xexample</span> <span class='kw'>do</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_xexample'>xexample</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>does something</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
Expand Down Expand Up @@ -1985,7 +1985,7 @@ <h3 class="signature " id="xit-class_method">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='id identifier rubyid_xit'>xit</span> <span class='kw'>do</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_xit'>xit</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>does something</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
Expand Down Expand Up @@ -2120,7 +2120,7 @@ <h3 class="signature " id="xspecify-class_method">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='id identifier rubyid_xspecify'>xspecify</span> <span class='kw'>do</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_xspecify'>xspecify</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>does something</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
Expand Down Expand Up @@ -2256,7 +2256,7 @@ <h3 class="signature first" id="described_class-instance_method">
</div>
<div class="tags">
<div class="examples">
<p class="tag_title">Examples:</p>
<h4 class="tag_title">Examples:</h4>
<pre class="example code"><code><span class='const'><span class='object_link'><a href="../../RSpec.html" title="RSpec (module)">RSpec</a></span></span><span class='period'>.</span><span class='id identifier rubyid_describe'>describe</span> <span class='const'>Thing</span> <span class='kw'>do</span>
<span class='id identifier rubyid_it'>it</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>does something</span><span class='tstring_end'>&quot;</span></span> <span class='kw'>do</span>
<span class='id identifier rubyid_described_class'>described_class</span> <span class='op'>==</span> <span class='const'>Thing</span>
Expand All @@ -2283,9 +2283,9 @@ <h3 class="signature first" id="described_class-instance_method">
</div>
</div>
<div id="footer">
Generated on Tue Sep 3 11:00:23 2024 by
Generated on Tue Oct 1 21:13:25 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-3.2.2).
0.9.37 (ruby-3.3.5).
</div>
</div>
</body>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: RSpec::Core::Formatters
&mdash; Documentation by YARD 0.9.36
&mdash; Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/style.css" type="text/css" />
<link rel="stylesheet" href="/documentation/3.13/rspec-core/css/common.css" type="text/css" />
Expand Down Expand Up @@ -200,9 +200,9 @@ <h3 class="signature first" id="register-class_method">
</div>
</div>
<div id="footer">
Generated on Tue Sep 3 11:00:22 2024 by
Generated on Tue Oct 1 21:13:24 2024 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.36 (ruby-3.2.2).
0.9.37 (ruby-3.3.5).
</div>
</div>
</body>
Expand Down
Loading

0 comments on commit f4c7015

Please sign in to comment.