docs(*): complete JSDoc for composeCorpus, sentences & stem

winkjs · Oct 12, 2017 · 81d063c · 81d063c
1 parent 2b1b333
commit 81d063c
Show file tree

Hide file tree

Showing 7 changed files with 477 additions and 41 deletions.
diff --git a/README.md b/README.md
@@ -30,7 +30,7 @@ var nlp = require( 'wink-nlp-utils' );
 // Extract person's name from a string:
 var name = nlp.string.extractPersonsName( 'Dr. Sarah Connor M. Tech., PhD. - AI' );
 console.log( name );
-// name -> 'Sarah Connor'
+// -> 'Sarah Connor'
 
 // Compose all possible sentences from a string:
 var str = '[I] [am having|have] [a] [problem|question]';

diff --git a/docs-toc.yml b/docs-toc.yml
@@ -1,7 +1,8 @@
 toc:
   - name: string
-  - string.bong
   - string.amplifyNotElision
+  - string.bong
+  - string.composeCorpus
   - string.extractPersonsName
   - string.extractRunOfCapitalWords
   - string.lowerCase
@@ -13,9 +14,11 @@ toc:
   - string.removePunctuations
   - string.removeSplChars
   - string.retainAlphaNums
+  - string.sentences
   - string.soc
   - string.song
   - string.splitElisions
+  - string.stem
   - string.trim
   - string.upperCase
   - name: helper