Skip to content

Commit

Permalink
Update documentation for 1.5.1
Browse files Browse the repository at this point in the history
  • Loading branch information
halostatue committed Jan 31, 2024
1 parent 1c6b43d commit c3e282e
Show file tree
Hide file tree
Showing 38 changed files with 1,548 additions and 669 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
research/
.byebug_history
Gemfile.lock
!js/*.js.gz
doc/
6 changes: 3 additions & 3 deletions Array.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="UTF-8">

<title>class Array - diff-lcs-1.5.0 Documentation</title>
<title>class Array - diff-lcs-1.5.1 Documentation</title>

<script type="text/javascript">
var rdoc_rel_prefix = "./";
Expand Down Expand Up @@ -41,7 +41,7 @@ <h2>
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>

Expand Down Expand Up @@ -99,7 +99,7 @@ <h1 id="class-Array" class="class">

<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.3.
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

44 changes: 29 additions & 15 deletions Code-of-Conduct_md.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="UTF-8">

<title>Code-of-Conduct - diff-lcs-1.5.0 Documentation</title>
<title>Code-of-Conduct - diff-lcs-1.5.1 Documentation</title>

<script type="text/javascript">
var rdoc_rel_prefix = "./";
Expand Down Expand Up @@ -41,7 +41,7 @@ <h2>
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>

Expand All @@ -57,14 +57,25 @@ <h2>
<div class="nav-section">
<h3>Table of Contents</h3>



<ul class="link-list" role="directory">
<li><a href="#label-Contributor+Covenant+Code+of+Conduct">Contributor Covenant Code of Conduct</a>
<li><a href="#label-Our+Pledge">Our Pledge</a>
<li><a href="#label-Our+Standards">Our Standards</a>
<li><a href="#label-Our+Responsibilities">Our Responsibilities</a>
<li><a href="#label-Scope">Scope</a>
<li><a href="#label-Enforcement">Enforcement</a>
<li><a href="#label-Attribution">Attribution</a>
<li>
<details open>
<summary> <a href="#label-Contributor+Covenant+Code+of+Conduct">Contributor Covenant Code of Conduct</a>
</summary>
<ul class="link-list" role="directory">
<li> <a href="#label-Our+Pledge">Our Pledge</a>
<li> <a href="#label-Our+Standards">Our Standards</a>
<li> <a href="#label-Our+Responsibilities">Our Responsibilities</a>
<li> <a href="#label-Scope">Scope</a>
<li> <a href="#label-Enforcement">Enforcement</a>
<li> <a href="#label-Attribution">Attribution</a>

</ul>
</details>
</li>

</ul>
</div>

Expand All @@ -81,8 +92,11 @@ <h3>Pages</h3>
<li><a href="./License_md.html">License</a>
<li><a href="./Manifest_txt.html">Manifest</a>
<li><a href="./README_rdoc.html">README</a>
<li><a href="./docs/COPYING_txt.html">COPYING</a>
<li><a href="./docs/artistic_txt.html">artistic</a>
<li><details><summary>docs</summary>
<ul class="link-list">
<li><a href="./docs/COPYING_txt.html">COPYING</a>
<li><a href="./docs/artistic_txt.html">artistic</a>
</ul></details>
</ul>
</div>

Expand Down Expand Up @@ -120,9 +134,9 @@ <h2 id="label-Our+Standards">Our Standards<span><a href="#label-Our+Standards">&
</li><li>
<p>Public or private harassment</p>
</li><li>
<p>Publishing others&#39; private information, such as a physical or electronic address, without explicit permission</p>
<p>Publishing others private information, such as a physical or electronic address, without explicit permission</p>
</li><li>
<p>Other conduct which could reasonably be considered inappropriate in a professional setting</p>
<p>Other conduct which could reasonably be considered inappropriate in a professional setting</p>
</li></ul>

<h2 id="label-Our+Responsibilities">Our Responsibilities<span><a href="#label-Our+Responsibilities">&para;</a> <a href="#top">&uarr;</a></span></h2>
Expand All @@ -139,7 +153,7 @@ <h2 id="label-Enforcement">Enforcement<span><a href="#label-Enforcement">&para;<

<p>Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.</p>

<p>Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project&#39;s leadership.</p>
<p>Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the projects leadership.</p>

<h2 id="label-Attribution">Attribution<span><a href="#label-Attribution">&para;</a> <a href="#top">&uarr;</a></span></h2>

Expand All @@ -151,7 +165,7 @@ <h2 id="label-Attribution">Attribution<span><a href="#label-Attribution">&para;<

<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.3.
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

48 changes: 33 additions & 15 deletions Contributing_md.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="UTF-8">

<title>Contributing - diff-lcs-1.5.0 Documentation</title>
<title>Contributing - diff-lcs-1.5.1 Documentation</title>

<script type="text/javascript">
var rdoc_rel_prefix = "./";
Expand Down Expand Up @@ -41,7 +41,7 @@ <h2>
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>

Expand All @@ -57,11 +57,22 @@ <h2>
<div class="nav-section">
<h3>Table of Contents</h3>



<ul class="link-list" role="directory">
<li><a href="#label-Contributing">Contributing</a>
<li><a href="#label-Test+Dependencies">Test Dependencies</a>
<li><a href="#label-Workflow">Workflow</a>
<li><a href="#label-Contributors">Contributors</a>
<li>
<details open>
<summary> <a href="#label-Contributing">Contributing</a>
</summary>
<ul class="link-list" role="directory">
<li> <a href="#label-Test+Dependencies">Test Dependencies</a>
<li> <a href="#label-Workflow">Workflow</a>
<li> <a href="#label-Contributors">Contributors</a>

</ul>
</details>
</li>

</ul>
</div>

Expand All @@ -78,8 +89,11 @@ <h3>Pages</h3>
<li><a href="./License_md.html">License</a>
<li><a href="./Manifest_txt.html">Manifest</a>
<li><a href="./README_rdoc.html">README</a>
<li><a href="./docs/COPYING_txt.html">COPYING</a>
<li><a href="./docs/artistic_txt.html">artistic</a>
<li><details><summary>docs</summary>
<ul class="link-list">
<li><a href="./docs/COPYING_txt.html">COPYING</a>
<li><a href="./docs/artistic_txt.html">artistic</a>
</ul></details>
</ul>
</div>

Expand All @@ -92,15 +106,15 @@ <h2 id="label-Contributing"><a href="Contributing_md.html">Contributing</a><span

<p>I value any contribution to <a href="LCS.html"><code>Diff::LCS</code></a> you can provide: a bug report, a feature request, or code contributions. Code contributions to <a href="LCS.html"><code>Diff::LCS</code></a> are especially &lt;del&gt;welcome&lt;/del&gt;encouraged. Because <a href="LCS.html"><code>Diff::LCS</code></a> is a complex codebase, there are a few guidelines:</p>
<ul><li>
<p>Code changes <em>will not</em> be accepted without tests. The test suite is written with [RSpec][].</p>
<p>Code changes <em>will not</em> be accepted without tests. The test suite is written with [RSpec][].</p>
</li><li>
<p>Match my coding style.</p>
</li><li>
<p>Use a thoughtfully-named topic branch that contains your change. Rebase your commits into logical chunks as necessary.</p>
<p>Use a thoughtfully-named topic branch that contains your change. Rebase your commits into logical chunks as necessary.</p>
</li><li>
<p>Use <a href="http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html">quality commit messages</a>.</p>
</li><li>
<p>Do not change the version number; when your patch is accepted and a release is made, the version will be updated at that point.</p>
<p>Do not change the version number; when your patch is accepted and a release is made, the version will be updated at that point.</p>
</li><li>
<p>Submit a GitHub pull request with your changes.</p>
</li><li>
Expand Down Expand Up @@ -135,7 +149,7 @@ <h3 id="label-Test+Dependencies">Test Dependencies<span><a href="#label-Test+Dep

<h3 id="label-Workflow">Workflow<span><a href="#label-Workflow">&para;</a> <a href="#top">&uarr;</a></span></h3>

<p>Here&#39;s the most direct way to get your work merged into the project:</p>
<p>Heres the most direct way to get your work merged into the project:</p>
<ul><li>
<p>Fork the project.</p>
</li><li>
Expand All @@ -151,15 +165,15 @@ <h3 id="label-Workflow">Workflow<span><a href="#label-Workflow">&para;</a> <a hr
</li><li>
<p>Push the branch up (<code>git push origin my_awesome_feature</code>).</p>
</li><li>
<p>Create a pull request against halostatue/diff-lcs and describe what your change does and the why you think it should be merged.</p>
<p>Create a pull request against halostatue/diff-lcs and describe what your change does and the why you think it should be merged.</p>
</li></ul>

<h3 id="label-Contributors">Contributors<span><a href="#label-Contributors">&para;</a> <a href="#top">&uarr;</a></span></h3>
<ul><li>
<p>Austin Ziegler created <a href="LCS.html"><code>Diff::LCS</code></a>.</p>
</li></ul>

<p>Thanks to everyone else who has contributed code or bug reports to Diff::LCS:</p>
<p>Thanks to everyone else who has contributed code or bug reports to <a href="LCS.html"><code>Diff::LCS</code></a>:</p>
<ul><li>
<p>@ginriki</p>
</li><li>
Expand Down Expand Up @@ -195,6 +209,8 @@ <h3 id="label-Contributors">Contributors<span><a href="#label-Contributors">&par
</li><li>
<p>Jun Aruga</p>
</li><li>
<p>Justin Steele</p>
</li><li>
<p>Kenichi Kamiya</p>
</li><li>
<p>Kensuke Nagae</p>
Expand All @@ -217,6 +233,8 @@ <h3 id="label-Contributors">Contributors<span><a href="#label-Contributors">&par
</li><li>
<p>Pete Higgins</p>
</li><li>
<p>Peter Goldstein</p>
</li><li>
<p>Peter Wagenet</p>
</li><li>
<p>Philippe Lafoucrière</p>
Expand All @@ -240,7 +258,7 @@ <h3 id="label-Contributors">Contributors<span><a href="#label-Contributors">&par

<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.3.
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

6 changes: 3 additions & 3 deletions Diff.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<head>
<meta charset="UTF-8">

<title>module Diff - diff-lcs-1.5.0 Documentation</title>
<title>module Diff - diff-lcs-1.5.1 Documentation</title>

<script type="text/javascript">
var rdoc_rel_prefix = "./";
Expand Down Expand Up @@ -41,7 +41,7 @@ <h2>
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>

Expand Down Expand Up @@ -85,7 +85,7 @@ <h1 id="module-Diff" class="module">

<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.3.
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.6.2.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>

Loading

0 comments on commit c3e282e

Please sign in to comment.