Skip to content

Commit 6cf80d2

Browse files
committed
Fix readme
1 parent 5816e32 commit 6cf80d2

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ before counting lexicon items.
9090
### Syllable Count
9191

9292
```ruby
93-
TextStat.syllable_count(text, lang='en_us')
93+
TextStat.syllable_count(text, language = 'en_us')
9494
```
9595

9696
Returns the number of syllables present in the given text.
@@ -117,7 +117,7 @@ TextStat.avg_sentence_length(text)
117117
### Average syllables per word
118118

119119
```ruby
120-
TextStat.avg_syllables_per_word(text)
120+
TextStat.avg_syllables_per_word(text, language = 'en_us')
121121
```
122122

123123
Returns the average syllables per word in the given text.
@@ -144,7 +144,7 @@ Default is `'en_us'`
144144
### The Flesch Reading Ease formula
145145

146146
```ruby
147-
TextStat.flesch_reading_ease(text)
147+
TextStat.flesch_reading_ease(text, language = 'en_us')
148148
```
149149

150150
Returns the Flesch Reading Ease Score.
@@ -172,7 +172,7 @@ the score can be. A negative score is valid.
172172
### The Flesch-Kincaid Grade Level
173173

174174
```ruby
175-
TextStat.flesch_kincaid_grade(text)
175+
TextStat.flesch_kincaid_grade(text, language = 'en_us')
176176
```
177177

178178
Returns the Flesch-Kincaid Grade of the given text. This is a grade
@@ -185,7 +185,7 @@ read the document.
185185
### The Fog Scale (Gunning FOG Formula)
186186

187187
```ruby
188-
TextStat.gunning_fog(text)
188+
TextStat.gunning_fog(text, language = 'en_us')
189189
```
190190

191191
Returns the FOG index of the given text. This is a grade formula in that
@@ -197,7 +197,7 @@ a score of 9.3 means that a ninth grader would be able to read the document.
197197
### The SMOG Index
198198

199199
```ruby
200-
TextStat.smog_index(text)
200+
TextStat.smog_index(text, language = 'en_us')
201201
```
202202

203203
Returns the SMOG index of the given text. This is a grade formula in that
@@ -242,7 +242,7 @@ able to read the document.
242242
### Linsear Write Formula
243243

244244
```ruby
245-
TextStat.linsear_write_formula(text)
245+
TextStat.linsear_write_formula(text, language = 'en_us')
246246
```
247247

248248
Returns the grade level using the Linsear Write Formula. This is
@@ -255,7 +255,7 @@ able to read the document.
255255
### Dale-Chall Readability Score
256256

257257
```ruby
258-
TextStat.dale_chall_readability_score(text)
258+
TextStat.dale_chall_readability_score(text, language = 'en_us')
259259
```
260260

261261
Different from other tests, since it uses a lookup table
@@ -288,7 +288,7 @@ Returns the grade level of the text using the Lix Formula.
288288
### FORCAST Readability Formula
289289

290290
```ruby
291-
TextStat.forcast(text)
291+
TextStat.forcast(text, language = 'en_us')
292292
```
293293

294294
Returns the grade level of the text using the FORCAST Readability Formula.
@@ -298,7 +298,7 @@ Returns the grade level of the text using the FORCAST Readability Formula.
298298
### Powers-Sumner-Kearl Readability Formula
299299

300300
```ruby
301-
TextStat.powers_sumner_kearl(text)
301+
TextStat.powers_sumner_kearl(text, language = 'en_us')
302302
```
303303

304304
Returns the grade level of the text using the Powers-Sumner-Kearl Readability Formula.
@@ -309,7 +309,7 @@ Returns the grade level of the text using the Powers-Sumner-Kearl Readability Fo
309309
### SPACHE Readability Formula
310310

311311
```ruby
312-
TextStat.spache(text)
312+
TextStat.spache(text, language = 'en_us')
313313
```
314314

315315
Returns the grade level of the text using the Spache Readability Formula.

0 commit comments

Comments
 (0)