summaryrefslogtreecommitdiff
path: root/src/node_modules/chance/docs/text/sentence.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2021-12-21 16:52:28 +0100
committerMinteck <contact@minteck.org>2021-12-21 16:52:28 +0100
commit46e43f4bde4a35785b4997b81e86cd19f046b69b (patch)
treec53c2f826f777f9d6b2d249dab556feb72a6c3a6 /src/node_modules/chance/docs/text/sentence.md
downloadlangdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.gz
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.tar.bz2
langdetect-46e43f4bde4a35785b4997b81e86cd19f046b69b.zip
Commit
Diffstat (limited to 'src/node_modules/chance/docs/text/sentence.md')
-rw-r--r--src/node_modules/chance/docs/text/sentence.md28
1 files changed, 28 insertions, 0 deletions
diff --git a/src/node_modules/chance/docs/text/sentence.md b/src/node_modules/chance/docs/text/sentence.md
new file mode 100644
index 0000000..0d5b447
--- /dev/null
+++ b/src/node_modules/chance/docs/text/sentence.md
@@ -0,0 +1,28 @@
+# sentence
+
+```js
+// usage
+chance.sentence()
+chance.sentence({ words: 5 })
+```
+
+Return a random sentence populated by semi-pronounceable random (nonsense) words.
+
+```js
+ chance.sentence();
+ => 'Witpevze mappos isoletu fo res bi geow pofin mu rupoho revzi utva ne.'
+```
+
+The sentence starts with a capital letter, and ends with a period.
+
+Default is a sentence with a random number of words from 12 to 18.
+
+*This length is chosen as the default as it works out to the average English
+sentence is in that range.*
+
+Optionally specify the number of words in the sentence.
+
+```js
+ chance.sentence({ words: 5 });
+ => 'Waddik jeasmov cakgilta ficub up.'
+```