Skip to content

Commit

Permalink
docs(*): complete JSDoc for string- song & bong
Browse files Browse the repository at this point in the history
  • Loading branch information
sanjayaksaxena committed Oct 12, 2017
1 parent 0ff2b70 commit 2b1b333
Show file tree
Hide file tree
Showing 7 changed files with 482 additions and 90 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ npm install wink-nlp-utils --save
```


## Usage
## Getting Started


```javascript

// Load wink-nlp-utils
var nlp = require( 'wink-nlp-utils' );

// Use a string Function - Input argument is a string
// 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'

// Compose all possible sentences from a string:
Expand All @@ -40,10 +40,10 @@ console.log( prepare.string.composeCorpus( str ) );
// -> 'I have a problem',
// -> 'I have a question' ]

// Use a tokens Function - Input argument is an array of tokens
// Remove stop words:
var t = nlp.tokens.removeWords( [ 'mary', 'had', 'a', 'little', 'lamb' ] );
// t -> [ 'mary', 'little', 'lamb' ]
console.log( t );
// -> [ 'mary', 'little', 'lamb' ]

```

Expand Down
4 changes: 3 additions & 1 deletion docs-toc.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
toc:
- name: string
- string.bong
- string.amplifyNotElision
- string.extractPersonsName
- string.extractRunOfCapitalWords
Expand All @@ -13,6 +14,7 @@ toc:
- string.removeSplChars
- string.retainAlphaNums
- string.soc
- string.song
- string.splitElisions
- string.trim
- string.upperCase
Expand All @@ -21,5 +23,5 @@ toc:
- helper.returnQuotedTextExtractor
- helper.returnWordsFilter
- name: type-defs
- wordsFilter
- indexer
- wordsFilter
Loading

0 comments on commit 2b1b333

Please sign in to comment.