Talk Gooder
+
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.
Contributions are welcome at github.com/brianwarner/talkgooder!
@@ -118,6 +123,9 @@FunctionsConvert a noun to its possessive, because apostrophes can be hard.
Given a quanity, determine if article should be ws or were.
diff --git a/docs/objects.inv b/docs/objects.inv
index f3f8468..8690110 100644
--- 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{)
ƄnZ& R 5}(jT-Pb?pr酻t5F5Ni -i&qe S?1sŵ/(`7@Sґ?/U >5(-Ȱ?=àY{[
Z.\Bf%7^s[
\ No newline at end of file
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
index 7b6b591..31d3ef6 100644
--- a/docs/py-modindex.html
+++ b/docs/py-modindex.html
@@ -5,14 +5,14 @@
- Python Module Index — talkGooder 0.0.post1.dev1+gbbb2af3 documentation
+ Python Module Index — talkGooder 1.1.0.post1.dev1+g2d50de4.d20241124 documentation
-
+
diff --git a/docs/search.html b/docs/search.html
index 725b72f..c630e79 100644
--- a/docs/search.html
+++ b/docs/search.html
@@ -5,7 +5,7 @@
- Search — talkGooder 0.0.post1.dev1+gbbb2af3 documentation
+ Search — talkGooder 1.1.0.post1.dev1+g2d50de4.d20241124 documentation
@@ -13,7 +13,7 @@
-
+
diff --git a/docs/searchindex.js b/docs/searchindex.js
index 3603d57..e763f05 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles": {"Functions": [[0, "functions"]], "Talk Gooder": [[0, "talk-gooder"]], "talkGooder documentation": [[0, null]]}, "docnames": ["index"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1}, "filenames": ["index.rst"], "indexentries": {"aan() (in module talkgooder)": [[0, "talkgooder.aAn", false]], "isare() (in module talkgooder)": [[0, "talkgooder.isAre", false]], "module": [[0, "module-talkgooder", false]], "num2word() (in module talkgooder)": [[0, "talkgooder.num2word", false]], "plural() (in module talkgooder)": [[0, "talkgooder.plural", false]], "possessive() (in module talkgooder)": [[0, "talkgooder.possessive", false]], "talkgooder": [[0, "module-talkgooder", false]], "waswere() (in module talkgooder)": [[0, "talkgooder.wasWere", false]]}, "objects": {"": [[0, 0, 0, "-", "talkgooder"]], "talkgooder": [[0, 1, 1, "", "aAn"], [0, 1, 1, "", "isAre"], [0, 1, 1, "", "num2word"], [0, 1, 1, "", "plural"], [0, 1, 1, "", "possessive"], [0, 1, 1, "", "wasWere"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:function"}, "terms": {"": 0, "0": 0, "1": 0, "2": 0, "9": 0, "A": 0, "For": 0, "It": 0, "The": 0, "There": 0, "aan": 0, "about": 0, "accommod": 0, "addit": 0, "addl_irregular": 0, "addl_sam": 0, "addl_special_": 0, "alwai": 0, "american": 0, "an": 0, "apa": 0, "apostroph": 0, "appli": 0, "applic": 0, "appropri": 0, "ar": 0, "articl": 0, "attempt": 0, "becaus": 0, "begin": 0, "between": 0, "brianwarn": 0, "can": 0, "caps_mod": 0, "case": 0, "cat": 0, "com": 0, "complic": 0, "consist": 0, "consumpt": 0, "contribut": 0, "convert": 0, "corner": 0, "current": 0, "default": 0, "depend": 0, "determin": 0, "dict": 0, "digit": 0, "don": 0, "e": 0, "els": 0, "en": 0, "end": 0, "english": 0, "equival": 0, "everyth": 0, "exampl": 0, "except": 0, "expand": 0, "extens": 0, "float": 0, "forc": 0, "form": 0, "format": 0, "g": 0, "gener": 0, "github": 0, "given": 0, "grammar": 0, "handl": 0, "hard": 0, "hello": 0, "human": 0, "i": 0, "infer": 0, "int": 0, "integ": 0, "intend": 0, "irregular": 0, "isar": 0, "item": 0, "its": 0, "know": 0, "languag": 0, "like": 0, "list": 0, "local": 0, "lower": 0, "made": 0, "manual": 0, "mice": 0, "most": 0, "mous": 0, "much": 0, "must": 0, "noun": 0, "num2word": 0, "number": 0, "odd": 0, "one": 0, "other": 0, "out": 0, "pair": 0, "paramet": 0, "peopl": 0, "per": 0, "person": 0, "piano": 0, "plural": 0, "possess": 0, "provid": 0, "punctuat": 0, "quaniti": 0, "quantiti": 0, "rais": 0, "reason": 0, "relat": 0, "repres": 0, "return": 0, "rule": 0, "same": 0, "should": 0, "singular": 0, "situat": 0, "smooth": 0, "so": 0, "soft": 0, "sourc": 0, "specif": 0, "specifi": 0, "str": 0, "string": 0, "style": 0, "suffix": 0, "suppli": 0, "support": 0, "t": 0, "text": 0, "thi": 0, "try": 0, "two": 0, "type": 0, "typeerror": 0, "u": 0, "upon": 0, "upper": 0, "us": 0, "user": 0, "v": 0, "valueerror": 0, "vowel": 0, "w": 0, "wa": 0, "waswer": 0, "welcom": 0, "were": 0, "when": 0, "where": 0, "whether": 0, "which": 0, "word": 0, "written": 0, "you": 0}, "titles": ["talkGooder documentation"], "titleterms": {"document": 0, "function": 0, "gooder": 0, "talk": 0, "talkgood": 0}})
\ No newline at end of file
+Search.setIndex({"alltitles": {"Functions": [[0, "functions"]], "Talk Gooder": [[0, "talk-gooder"]], "talkGooder documentation": [[0, null]]}, "docnames": ["index"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.viewcode": 1}, "filenames": ["index.rst"], "indexentries": {"aan() (in module talkgooder)": [[0, "talkgooder.aAn", false]], "isare() (in module talkgooder)": [[0, "talkgooder.isAre", false]], "module": [[0, "module-talkgooder", false]], "num2word() (in module talkgooder)": [[0, "talkgooder.num2word", false]], "plural() (in module talkgooder)": [[0, "talkgooder.plural", false]], "possessive() (in module talkgooder)": [[0, "talkgooder.possessive", false]], "talkgooder": [[0, "module-talkgooder", false]], "waswere() (in module talkgooder)": [[0, "talkgooder.wasWere", false]]}, "objects": {"": [[0, 0, 0, "-", "talkgooder"]], "talkgooder": [[0, 1, 1, "", "aAn"], [0, 1, 1, "", "isAre"], [0, 1, 1, "", "num2word"], [0, 1, 1, "", "plural"], [0, 1, 1, "", "possessive"], [0, 1, 1, "", "wasWere"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:function"}, "terms": {"": 0, "0": 0, "1": 0, "16": 0, "2": 0, "9": 0, "A": 0, "For": 0, "It": 0, "The": 0, "There": 0, "aan": 0, "about": 0, "accommod": 0, "addit": 0, "addl_irregular": 0, "addl_sam": 0, "addl_special_": 0, "alwai": 0, "american": 0, "an": 0, "apa": 0, "apostroph": 0, "appli": 0, "applic": 0, "appropri": 0, "ar": 0, "articl": 0, "attempt": 0, "becaus": 0, "begin": 0, "between": 0, "both": 0, "brianwarn": 0, "can": 0, "caps_mod": 0, "case": 0, "cat": 0, "com": 0, "complic": 0, "consist": 0, "consumpt": 0, "contribut": 0, "convert": 0, "corner": 0, "current": 0, "default": 0, "depend": 0, "determin": 0, "dict": 0, "digit": 0, "don": 0, "e": 0, "els": 0, "en": 0, "end": 0, "english": 0, "equival": 0, "everyth": 0, "exampl": 0, "except": 0, "expand": 0, "extens": 0, "float": 0, "forc": 0, "form": 0, "format": 0, "g": 0, "gener": 0, "github": 0, "given": 0, "grammar": 0, "handl": 0, "hard": 0, "hello": 0, "human": 0, "i": 0, "infer": 0, "int": 0, "integ": 0, "intend": 0, "irregular": 0, "isar": 0, "item": 0, "its": 0, "know": 0, "languag": 0, "like": 0, "list": 0, "local": 0, "lower": 0, "made": 0, "manual": 0, "mice": 0, "most": 0, "mous": 0, "much": 0, "must": 0, "noun": 0, "num2word": 0, "number": 0, "odd": 0, "one": 0, "orang": 0, "other": 0, "out": 0, "pair": 0, "paramet": 0, "peopl": 0, "per": 0, "person": 0, "piano": 0, "plural": 0, "possess": 0, "provid": 0, "punctuat": 0, "quaniti": 0, "quantiti": 0, "rais": 0, "reason": 0, "relat": 0, "repres": 0, "return": 0, "rule": 0, "same": 0, "should": 0, "singular": 0, "situat": 0, "smooth": 0, "so": 0, "soft": 0, "sourc": 0, "specif": 0, "specifi": 0, "str": 0, "string": 0, "style": 0, "suffix": 0, "suppli": 0, "support": 0, "t": 0, "text": 0, "thi": 0, "toi": 0, "try": 0, "two": 0, "type": 0, "typeerror": 0, "u": 0, "upon": 0, "upper": 0, "us": 0, "user": 0, "v": 0, "valueerror": 0, "vowel": 0, "w": 0, "wa": 0, "waswer": 0, "welcom": 0, "were": 0, "when": 0, "where": 0, "whether": 0, "which": 0, "word": 0, "written": 0, "you": 0, "zero": 0}, "titles": ["talkGooder documentation"], "titleterms": {"document": 0, "function": 0, "gooder": 0, "talk": 0, "talkgood": 0}})
\ No newline at end of file
diff --git a/docsrc/index.rst b/docsrc/index.rst
index d7a60a3..625ffed 100644
--- 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:
-----
Convert a noun to its possessive, because apostrophes can be hard.
Given a quanity, determine if article should be ws or were.