refactored text_stats module into a sub-package with the same name and top-level API, but with underlying functionality broken out into separate modules
improved performance, API, and documentation on the core TextStats class, plus improved documentation on the individual stats functions
added new readability tests -- Automatic Arabic Readability Index (for Arabic texts), µ-legibility and perspecuity index (for Spanish texts), and a Turkish formulation for Flesch Reading Ease -- and a new basic stat -- word entropy
TODO:
[x] add tests for the new and revised functionality
Motivation and Context
This was an under-nurtured part of the code base, with some weird corners and clunky API decisions.
How Has This Been Tested?
All tests pass!
Types of changes
[ ] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[x] Breaking change (fix or feature that would cause existing functionality to change)
Checklist:
[x] My code follows the code style of this project.
[x] My change requires a change to the documentation, and I have updated it accordingly.
Description
text_stats
module into a sub-package with the same name and top-level API, but with underlying functionality broken out into separate modulesTextStats
class, plus improved documentation on the individual stats functionsTODO:
Motivation and Context
This was an under-nurtured part of the code base, with some weird corners and clunky API decisions.
How Has This Been Tested?
All tests pass!
Types of changes
Checklist: