Skip to content

Update doc with updated yard #131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Mar 8, 2020
Merged

Update doc with updated yard #131

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b5d6c5d
Update doc with updated yard
benoittgt Jan 2, 2020
7392e05
Doc with yard updated
benoittgt Jan 29, 2020
6d0c0a1
Regenerate doc with updated redcarpet
benoittgt Feb 26, 2020
ebe7a89
Switch to specific yardopts for each project + fix rspec-rails README
benoittgt Feb 26, 2020
17a7c9b
Switch to Ruby 2.6.3 to avoid wrong comment position in source block
benoittgt Mar 6, 2020
f6dc016
Avoid missing intro comment in RSpec::Core::Formatters
benoittgt Mar 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Gemfile.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,4 +183,4 @@ DEPENDENCIES
slim

BUNDLED WITH
1.17.3
2.1.1
8 changes: 4 additions & 4 deletions source/documentation/3.9/rspec-core/RSpec.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<title>
Module: RSpec

&mdash; Documentation by YARD 0.9.16
&mdash; Documentation by YARD 0.9.24

</title>

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
<script type="text/javascript">
pathId = "RSpec";
relpath = '';
</script>
Expand Down Expand Up @@ -709,9 +709,9 @@ <h3 class="signature " id="reset-class_method">
</div>

<div id="footer">
Generated on Tue Oct 8 11:36:06 2019 by
Generated on Fri Mar 6 15:02:11 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.16 (ruby-2.6.5).
0.9.24 (ruby-2.6.3).
</div>

<script>
Expand Down
8 changes: 4 additions & 4 deletions source/documentation/3.9/rspec-core/RSpec/Core.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<title>
Module: RSpec::Core

&mdash; Documentation by YARD 0.9.16
&mdash; Documentation by YARD 0.9.24

</title>

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
<script type="text/javascript">
pathId = "RSpec::Core";
relpath = '../';
</script>
Expand Down Expand Up @@ -144,9 +144,9 @@ <h2>
</div>

<div id="footer">
Generated on Tue Oct 8 11:36:06 2019 by
Generated on Fri Mar 6 15:02:11 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.16 (ruby-2.6.5).
0.9.24 (ruby-2.6.3).
</div>

<script>
Expand Down
16 changes: 8 additions & 8 deletions source/documentation/3.9/rspec-core/RSpec/Core/Configuration.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<title>
Class: RSpec::Core::Configuration

&mdash; Documentation by YARD 0.9.16
&mdash; Documentation by YARD 0.9.24

</title>

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
<script type="text/javascript">
pathId = "RSpec::Core::Configuration";
relpath = '../../';
</script>
Expand Down Expand Up @@ -3223,7 +3223,7 @@ <h3 class="signature " id="example_status_persistence_file_path-instance_method"
<span class="signature">#<strong>example_status_persistence_file_path</strong> &#x21d2; <tt>String</tt> </span>
<div class="docstring">
<div class="discussion">
<p>Returns the file path</p>
<p>Returns the file path.</p>


</div>
Expand Down Expand Up @@ -4215,7 +4215,7 @@ <h3 class="signature " id="shared_context_metadata_behavior-instance_method">
<span class="signature">#<strong>shared_context_metadata_behavior</strong> &#x21d2; <tt>:trigger_inclusion</tt>, <tt>:apply_to_host_groups</tt> </span>
<div class="docstring">
<div class="discussion">
<p>Returns the configured behavior</p>
<p>Returns the configured behavior.</p>


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

</h3><div class="docstring">
<div class="discussion">
<p>Returns full description filter</p>
<p>Returns full description filter.</p>


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

</h3><div class="docstring">
<div class="discussion">
<p>Returns the currently configured reporter</p>
<p>Returns the currently configured reporter.</p>


</div>
Expand Down Expand Up @@ -8695,9 +8695,9 @@ <h3 class="signature " id="when_first_matching_example_defined-instance_method">
</div>

<div id="footer">
Generated on Tue Oct 8 11:36:08 2019 by
Generated on Fri Mar 6 15:02:13 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.16 (ruby-2.6.5).
0.9.24 (ruby-2.6.3).
</div>

<script>
Expand Down
14 changes: 7 additions & 7 deletions source/documentation/3.9/rspec-core/RSpec/Core/ConfigurationOptions.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<title>
Class: RSpec::Core::ConfigurationOptions

&mdash; Documentation by YARD 0.9.16
&mdash; Documentation by YARD 0.9.24

</title>

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
<script type="text/javascript">
pathId = "RSpec::Core::ConfigurationOptions";
relpath = '../../';
</script>
Expand Down Expand Up @@ -275,7 +275,7 @@ <h3 class="signature first" id="initialize-instance_method">

</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of ConfigurationOptions</p>
<p>Returns a new instance of ConfigurationOptions.</p>


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

</h3><div class="docstring">
<div class="discussion">
<p>Returns the original command-line arguments</p>
<p>Returns the original command-line arguments.</p>


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

</h3><div class="docstring">
<div class="discussion">
<p>Returns the final merged options, drawn from all external sources</p>
<p>Returns the final merged options, drawn from all external sources.</p>


</div>
Expand Down Expand Up @@ -591,9 +591,9 @@ <h3 class="signature " id="configure_filter_manager-instance_method">
</div>

<div id="footer">
Generated on Tue Oct 8 11:36:09 2019 by
Generated on Fri Mar 6 15:02:14 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.16 (ruby-2.6.5).
0.9.24 (ruby-2.6.3).
</div>

<script>
Expand Down
8 changes: 4 additions & 4 deletions source/documentation/3.9/rspec-core/RSpec/Core/DSL.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<title>
Module: RSpec::Core::DSL

&mdash; Documentation by YARD 0.9.16
&mdash; Documentation by YARD 0.9.24

</title>

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
<script type="text/javascript">
pathId = "RSpec::Core::DSL";
relpath = '../../';
</script>
Expand Down Expand Up @@ -307,9 +307,9 @@ <h3 class="signature " id="remove_globally!-class_method">
</div>

<div id="footer">
Generated on Tue Oct 8 11:36:06 2019 by
Generated on Fri Mar 6 15:02:11 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.16 (ruby-2.6.5).
0.9.24 (ruby-2.6.3).
</div>

<script>
Expand Down
12 changes: 6 additions & 6 deletions source/documentation/3.9/rspec-core/RSpec/Core/Example.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<title>
Class: RSpec::Core::Example

&mdash; Documentation by YARD 0.9.16
&mdash; Documentation by YARD 0.9.24

</title>

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
<script type="text/javascript">
pathId = "RSpec::Core::Example";
relpath = '../../';
</script>
Expand Down Expand Up @@ -935,7 +935,7 @@ <h3 class="signature " id="reporter-instance_method">

</h3><div class="docstring">
<div class="discussion">
<p>Returns the current reporter for the example</p>
<p>Returns the current reporter for the example.</p>


</div>
Expand Down Expand Up @@ -1512,7 +1512,7 @@ <h3 class="signature " id="location-instance_method">
</h3><div class="docstring">
<div class="discussion">
<p>Returns the exact source location of this example in a form
like <code>./path/to/spec.rb:17</code></p>
like <code>./path/to/spec.rb:17</code>.</p>


</div>
Expand Down Expand Up @@ -1940,9 +1940,9 @@ <h3 class="signature " id="skip-instance_method">
</div>

<div id="footer">
Generated on Tue Oct 8 11:36:06 2019 by
Generated on Fri Mar 6 15:02:12 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.16 (ruby-2.6.5).
0.9.24 (ruby-2.6.3).
</div>

<script>
Expand Down
8 changes: 4 additions & 4 deletions source/documentation/3.9/rspec-core/RSpec/Core/Example/ExecutionResult.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<title>
Class: RSpec::Core::Example::ExecutionResult

&mdash; Documentation by YARD 0.9.16
&mdash; Documentation by YARD 0.9.24

</title>

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
<script type="text/javascript">
pathId = "RSpec::Core::Example::ExecutionResult";
relpath = '../../../';
</script>
Expand Down Expand Up @@ -1074,9 +1074,9 @@ <h3 class="signature " id="record_finished-instance_method">
</div>

<div id="footer">
Generated on Tue Oct 8 11:36:06 2019 by
Generated on Fri Mar 6 15:02:12 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.16 (ruby-2.6.5).
0.9.24 (ruby-2.6.3).
</div>

<script>
Expand Down
10 changes: 5 additions & 5 deletions source/documentation/3.9/rspec-core/RSpec/Core/Example/Procsy.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<title>
Class: RSpec::Core::Example::Procsy

&mdash; Documentation by YARD 0.9.16
&mdash; Documentation by YARD 0.9.24

</title>

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
<script type="text/javascript">
pathId = "RSpec::Core::Example::Procsy";
relpath = '../../../';
</script>
Expand Down Expand Up @@ -295,7 +295,7 @@ <h3 class="signature first" id="initialize-instance_method">

</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of Procsy</p>
<p>Returns a new instance of Procsy.</p>


</div>
Expand Down Expand Up @@ -527,9 +527,9 @@ <h3 class="signature " id="to_proc-instance_method">
</div>

<div id="footer">
Generated on Tue Oct 8 11:36:06 2019 by
Generated on Fri Mar 6 15:02:12 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.16 (ruby-2.6.5).
0.9.24 (ruby-2.6.3).
</div>

<script>
Expand Down
12 changes: 6 additions & 6 deletions source/documentation/3.9/rspec-core/RSpec/Core/ExampleGroup.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
<title>
Class: RSpec::Core::ExampleGroup

&mdash; Documentation by YARD 0.9.16
&mdash; Documentation by YARD 0.9.24

</title>

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="/documentation/3.9/rspec-core/css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
<script type="text/javascript">
pathId = "RSpec::Core::ExampleGroup";
relpath = '../../';
</script>
Expand Down Expand Up @@ -822,7 +822,7 @@ <h3 class="signature first" id="initialize-instance_method">

</h3><div class="docstring">
<div class="discussion">
<p>Returns a new instance of ExampleGroup</p>
<p>Returns a new instance of ExampleGroup.</p>


</div>
Expand Down Expand Up @@ -1021,7 +1021,7 @@ <h3 class="signature " id="description-class_method">

</h3><div class="docstring">
<div class="discussion">
<p>Returns the current example group description</p>
<p>Returns the current example group description.</p>


</div>
Expand Down Expand Up @@ -4795,9 +4795,9 @@ <h3 class="signature first" id="described_class-instance_method">
</div>

<div id="footer">
Generated on Tue Oct 8 11:36:08 2019 by
Generated on Fri Mar 6 15:02:13 2020 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.16 (ruby-2.6.5).
0.9.24 (ruby-2.6.3).
</div>

<script>
Expand Down
Loading