search

words / gunning-fog

Formula to detect the ease of reading a text according to the Gunning fog index (1952)
https://wooorm.com/readability/
MIT License
18 stars 2 forks source link

Error in the example #7

Closed AmenRa closed 7 years ago

AmenRa commented 8 years ago

Hi, I noticed an error in the example under "Usage" section. You wrote:

/* For “The Australian platypus is seemingly a hybrid of

  • a mammal and reptilian creature.” (1 sentence; 13 words;
  • 26 syllables; 4 polysillabic words, 2 of which jargon/proper
  • nouns). */

gunningFog({ sentence: 1, word: 13, complexPolysillabicWord: 2 });

The complex polysyllabic words are 4 and not 2, I counted the syllables with your node module "syllables", with "nlp-compromise"/"nlp-syllables" and online here: http://gunning-fog-index.com/.

Minor error: polysYllabic, not polysillabic. (I'm trying to help not to be offensive)

Thank you for all you work to bring nlp-related things in JS!

wooorm commented 8 years ago

Thanks for pointing this out, @AmenRa666!

Would you be interested in creating a PR?

If so, after cloning, and making the changes, do npm install and npm test, which will check code-style, run tests, and whatnot. Thanks again!

AmenRa commented 8 years ago

Yeah, I think I can do it. Tomorrow I'll try. (I'm kinda new with Git)

wooorm commented 8 years ago

Cool, let me know if it works out, or not, or if I can help :)

wooorm commented 8 years ago

@AmenRa666 Ping!