Update docs

Signed-off-by: Brian Warner <[email protected]>
brianwarner · Nov 24, 2024 · 22558e7 · 22558e7
1 parent 2d50de4
commit 22558e7
Show file tree

Hide file tree

Showing 13 changed files with 41 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -1,14 +1,20 @@
 # Talk Gooder
 
+![PyPI - License](https://img.shields.io/pypi/l/talkgooder?color=blue)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/brianwarner/talkgooder/pre-release.yml?label=Build%20and%20test)
+![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/brianwarner/talkgooder/release.yml?label=Publish%20to%20PyPI)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/talkgooder)
+
 `talkgooder` attempts to smooth out grammar, punctuation, and number-related corner cases when formatting text for human consumption. It is intended for applications where you know there's a noun and are trying to generate text, but you don't know much about it.
 
 It handles:
 
-* Plurals
-* Possessives
-* Numbers to words
-* "There is" vs. "There are"
-* "A" vs. "An"
+* Plurals: "one cat" vs. "zero cats"
+* Possessives: "the cat's toy" vs. "both cats' toys"
+* Numbers to words: 2 == "two", 16 == 16
+* "There is" vs. "There are": "There is one cat" vs. "There are two cats"
+* "A" vs. "An": "A cat" vs. "An orange cat"
+* "Was" vs. "Were": "There was one cat" vs. "There were two cats"
 
 ``talkgooder`` is currently specific to American English, but it is extensible to other languages.
 

diff --git a/docs/.buildinfo b/docs/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 84312769acdb3225cceb4714f4036a2f
+config: 9d9755ef37820184fe52322f4c5eb4ae
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/.buildinfo.bak b/docs/.buildinfo.bak
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: c275350ed3fba61546b0b0ef51753182
+config: 84312769acdb3225cceb4714f4036a2f
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; talkGooder 0.0.post1.dev1+gbbb2af3 documentation</title>
+  <title>Overview: module code &mdash; talkGooder 1.1.0.post1.dev1+g2d50de4.d20241124 documentation</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />
 
 
       <script src="../_static/jquery.js?v=5d32c60e"></script>
       <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="../_static/documentation_options.js?v=435997b2"></script>
+      <script src="../_static/documentation_options.js?v=b7d5b88b"></script>
       <script src="../_static/doctools.js?v=9bcbadda"></script>
       <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/js/theme.js"></script>

diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt
@@ -22,6 +22,7 @@ Functions
    talkgooder.num2word :no-index:
    talkgooder.plural :no-index:
    talkgooder.possessive :no-index:
+   talkgooder.wasWere :no-index:
 
 -----
 

diff --git a/docs/_static/documentation_options.js b/docs/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.0.post1.dev1+gbbb2af3',
+    VERSION: '1.1.0.post1.dev1+g2d50de4.d20241124',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/docs/genindex.html b/docs/genindex.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Index &mdash; talkGooder 0.0.post1.dev1+gbbb2af3 documentation</title>
+  <title>Index &mdash; talkGooder 1.1.0.post1.dev1+g2d50de4.d20241124 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="_static/documentation_options.js?v=435997b2"></script>
+      <script src="_static/documentation_options.js?v=b7d5b88b"></script>
       <script src="_static/doctools.js?v=9bcbadda"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

diff --git a/docs/index.html b/docs/index.html
@@ -6,14 +6,14 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>talkGooder documentation &mdash; talkGooder 0.0.post1.dev1+gbbb2af3 documentation</title>
+  <title>talkGooder documentation &mdash; talkGooder 1.1.0.post1.dev1+g2d50de4.d20241124 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="_static/documentation_options.js?v=435997b2"></script>
+      <script src="_static/documentation_options.js?v=b7d5b88b"></script>
       <script src="_static/doctools.js?v=9bcbadda"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>
@@ -87,14 +87,19 @@
 <h1>talkGooder documentation<a class="headerlink" href="#talkgooder-documentation" title="Link to this heading"></a></h1>
 <section id="talk-gooder">
 <h2>Talk Gooder<a class="headerlink" href="#talk-gooder" title="Link to this heading"></a></h2>
+<p><img alt="PyPI - License" src="https://img.shields.io/pypi/l/talkgooder?color=blue" />
+<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/brianwarner/talkgooder/pre-release.yml?label=Build%20and%20test" />
+<img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/brianwarner/talkgooder/release.yml?label=Publish%20to%20PyPI" />
+<img alt="PyPI - Downloads" src="https://img.shields.io/pypi/dm/talkgooder" /></p>
 <p><code class="docutils literal notranslate"><span class="pre">talkgooder</span></code> attempts to smooth out grammar, punctuation, and number-related corner cases when formatting text for human consumption. It is intended for applications where you know there’s a noun and are trying to generate text, but you don’t know much about it.</p>
 <p>It handles:</p>
 <ul class="simple">
-<li><p>Plurals</p></li>
-<li><p>Possessives</p></li>
-<li><p>Numbers to words</p></li>
-<li><p>“There is” vs. “There are”</p></li>
-<li><p>“A” vs. “An”</p></li>
+<li><p>Plurals: “one cat” vs. “zero cats”</p></li>
+<li><p>Possessives: “the cat’s toy” vs. “both cats’ toys”</p></li>
+<li><p>Numbers to words: 2 == “two”, 16 == 16</p></li>
+<li><p>“There is” vs. “There are”: “There is one cat” vs. “There are two cats”</p></li>
+<li><p>“A” vs. “An”: “A cat” vs. “An orange cat”</p></li>
+<li><p>“Was” vs. “Were”: “There was one cat” vs. “There were two cats”</p></li>
 </ul>
 <p><code class="docutils literal notranslate"><span class="pre">talkgooder</span></code> is currently specific to American English, but it is extensible to other languages.</p>
 <p>Contributions are welcome at <a class="reference external" href="https://github.com/brianwarner/talkgooder">github.com/brianwarner/talkgooder</a>!</p>
@@ -118,6 +123,9 @@ <h2>Functions<a class="headerlink" href="#functions" title="Link to this heading
 <tr class="row-odd"><td><p><a class="reference internal" href="#talkgooder.possessive" title="talkgooder.possessive"><code class="xref py py-obj docutils literal notranslate"><span class="pre">talkgooder.possessive</span></code></a></p></td>
 <td><p>Convert a noun to its possessive, because apostrophes can be hard.</p></td>
 </tr>
+<tr class="row-even"><td><p><a class="reference internal" href="#talkgooder.wasWere" title="talkgooder.wasWere"><code class="xref py py-obj docutils literal notranslate"><span class="pre">talkgooder.wasWere</span></code></a></p></td>
+<td><p>Given a quanity, determine if article should be <code class="docutils literal notranslate"><span class="pre">ws</span></code> or <code class="docutils literal notranslate"><span class="pre">were</span></code>.</p></td>
+</tr>
 </tbody>
 </table>
 <hr class="docutils" />

diff --git a/docs/objects.inv b/docs/objects.inv
@@ -1,6 +1,6 @@
 # Sphinx inventory version 2
 # Project: talkGooder
-# Version: 0.0.post1.dev1+gbbb2af3
+# Version: 1.1.0.post1.dev1+g2d50de4.d20241124
 # The remainder of this file is compressed using zlib.
 xڍ���0F�>�Mt-G6&�`b��\���%�y{)
 Ƅn������Z&�R5�}�(��j��T����-Pb?p�r酻�����t�����5F��5�Ni-��i&�qeS?��1sŵ/�(���`7@S�ґ��?�/�U���>��5(-��Ȱ�?׷=�����àY���{[�Z��.����\Bf%�7^s�[

diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -5,14 +5,14 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Python Module Index &mdash; talkGooder 0.0.post1.dev1+gbbb2af3 documentation</title>
+  <title>Python Module Index &mdash; talkGooder 1.1.0.post1.dev1+g2d50de4.d20241124 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="_static/documentation_options.js?v=435997b2"></script>
+      <script src="_static/documentation_options.js?v=b7d5b88b"></script>
       <script src="_static/doctools.js?v=9bcbadda"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

diff --git a/docs/search.html b/docs/search.html
@@ -5,15 +5,15 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Search &mdash; talkGooder 0.0.post1.dev1+gbbb2af3 documentation</title>
+  <title>Search &mdash; talkGooder 1.1.0.post1.dev1+g2d50de4.d20241124 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
 
 
 
       <script src="_static/jquery.js?v=5d32c60e"></script>
       <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-      <script src="_static/documentation_options.js?v=435997b2"></script>
+      <script src="_static/documentation_options.js?v=b7d5b88b"></script>
       <script src="_static/doctools.js?v=9bcbadda"></script>
       <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/js/theme.js"></script>

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docsrc/index.rst b/docsrc/index.rst
@@ -22,6 +22,7 @@ Functions
    talkgooder.num2word :no-index:
    talkgooder.plural :no-index:
    talkgooder.possessive :no-index:
+   talkgooder.wasWere :no-index:
 
 -----