Merge pull request #2 from laelhalawani/develop

Develop

.github/workflows/static.yml

@@ -39,7 +39,7 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:
-          path: 'docs/handlers'
+          path: 'docs/util_helper'
 
       - name: Deploy to GitHub Pages
         id: deployment

README.md

@@ -1,2 +1,4 @@
-# handlers
-A few scripts 
+# util_helpers
+A few scripts to help with various tasks.
+Detailed documentation at
+https://laelhalawani.github.io/util_helper

docs/handlers/compare_strings.html → docs/util_helper/compare_strings.html

@@ -4,7 +4,7 @@
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
 <meta name="generator" content="pdoc 0.10.0" />
-<title>handlers.compare_strings API documentation</title>
+<title>util_helper.compare_strings API documentation</title>
 <meta name="description" content="" />
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
 <link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
@@ -19,7 +19,7 @@
 <main>
 <article id="content">
 <header>
-<h1 class="title">Module <code>handlers.compare_strings</code></h1>
+<h1 class="title">Module <code>util_helper.compare_strings</code></h1>
 </header>
 <section id="section-intro">
 <details class="source">
@@ -88,7 +88,7 @@ <h1 class="title">Module <code>handlers.compare_strings</code></h1>
 <section>
 <h2 class="section-title" id="header-functions">Functions</h2>
 <dl>
-<dt id="handlers.compare_strings.compare_two_strings"><code class="name flex">
+<dt id="util_helper.compare_strings.compare_two_strings"><code class="name flex">
 <span>def <span class="ident">compare_two_strings</span></span>(<span>compare_a: str, compare_b: str, case_sensitive=False)</span>
 </code></dt>
 <dd>
@@ -106,7 +106,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
     return sequence_matcher.ratio()</code></pre>
 </details>
 </dd>
-<dt id="handlers.compare_strings.compare_two_strings_squared"><code class="name flex">
+<dt id="util_helper.compare_strings.compare_two_strings_squared"><code class="name flex">
 <span>def <span class="ident">compare_two_strings_squared</span></span>(<span>compare_a: str, compare_b: str, case_sensitive=False)</span>
 </code></dt>
 <dd>
@@ -124,7 +124,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
     return sequence_matcher.ratio()**2</code></pre>
 </details>
 </dd>
-<dt id="handlers.compare_strings.find_most_similar"><code class="name flex">
+<dt id="util_helper.compare_strings.find_most_similar"><code class="name flex">
 <span>def <span class="ident">find_most_similar</span></span>(<span>query: str, find_in_iter: str, cutoff: float = 0.5, case_sensitive=False)</span>
 </code></dt>
 <dd>
@@ -152,7 +152,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
     return results</code></pre>
 </details>
 </dd>
-<dt id="handlers.compare_strings.find_most_similar_squared"><code class="name flex">
+<dt id="util_helper.compare_strings.find_most_similar_squared"><code class="name flex">
 <span>def <span class="ident">find_most_similar_squared</span></span>(<span>query: str, find_in_iter: str, cutoff: float = 0.5, case_sensitive=False)</span>
 </code></dt>
 <dd>
@@ -193,15 +193,15 @@ <h1>Index</h1>
 <ul id="index">
 <li><h3>Super-module</h3>
 <ul>
-<li><code><a title="handlers" href="index.html">handlers</a></code></li>
+<li><code><a title="util_helper" href="index.html">util_helper</a></code></li>
 </ul>
 </li>
 <li><h3><a href="#header-functions">Functions</a></h3>
 <ul class="">
-<li><code><a title="handlers.compare_strings.compare_two_strings" href="#handlers.compare_strings.compare_two_strings">compare_two_strings</a></code></li>
-<li><code><a title="handlers.compare_strings.compare_two_strings_squared" href="#handlers.compare_strings.compare_two_strings_squared">compare_two_strings_squared</a></code></li>
-<li><code><a title="handlers.compare_strings.find_most_similar" href="#handlers.compare_strings.find_most_similar">find_most_similar</a></code></li>
-<li><code><a title="handlers.compare_strings.find_most_similar_squared" href="#handlers.compare_strings.find_most_similar_squared">find_most_similar_squared</a></code></li>
+<li><code><a title="util_helper.compare_strings.compare_two_strings" href="#util_helper.compare_strings.compare_two_strings">compare_two_strings</a></code></li>
+<li><code><a title="util_helper.compare_strings.compare_two_strings_squared" href="#util_helper.compare_strings.compare_two_strings_squared">compare_two_strings_squared</a></code></li>
+<li><code><a title="util_helper.compare_strings.find_most_similar" href="#util_helper.compare_strings.find_most_similar">find_most_similar</a></code></li>
+<li><code><a title="util_helper.compare_strings.find_most_similar_squared" href="#util_helper.compare_strings.find_most_similar_squared">find_most_similar_squared</a></code></li>
 </ul>
 </li>
 </ul>