Checklist

Please check the options that you have completed and strike-out the options that do not apply via this pull request:

[X] a clear title and description to the Pull Request has been provided
[X] you have read
- [X] the Contributing doc
- [X] the Developer Guide
[X] the pull request passes the tests (`./test-coverage "tests slow-tests"``) - this will also be visible via the Code coverage report and CI/CD task on the Pull Request
[X] you have performed some kind of smoke test by running your changes in an isolated environment i.e. Docker container, Google Colab, Kaggle, etc...
[ ] ~the notebooks are updated (see notebooks folder, read the Notebooks docs)~ - to be moved to release section of repo
[x] CHANGELOG.md has been updated (please follow the existing format)

Goal or purpose of the PR

Added new feature(s) to the granular features groups:

[x] count syllables extracted from the text provided.

Changes implemented in the PR

Add functionality into the granular features aspects of the library
Added acceptance tests to check for end-to-end flow (correctness)
- extended input data with new variants to cover for the newly added feature(s)
- updated expectation data files (.csv files)
added a short line of text to the developer guide
upgraded language_tool_python from 2.3.1 to 2.5.3, which fixes a failing test
updated the failing test expected results data file

codecov[bot] commented 3 years ago

Codecov Report

Merging #61 (7a01d6f) into master (a1c112d) will not change coverage. The diff coverage is 100.00%.

:exclamation: Current head 7a01d6f differs from pull request most recent head 3203597. Consider uploading reports for the commit 3203597 to get more accurate results

@@            Coverage Diff            @@
##            master       #61   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           25        26    +1     
  Lines          490       498    +8     
  Branches        73        74    +1     
=========================================
+ Hits           490       498    +8

Impacted Files	Coverage Δ
nlp_profiler/constants.py	`100.00% <100.00%> (ø)`
nlp_profiler/granular_features/__init__.py	`100.00% <100.00%> (ø)`
nlp_profiler/granular_features/syllables.py	`100.00% <100.00%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update db094b9...3203597. Read the comment docs.

sourcery-ai[bot] commented 3 years ago

Sourcery Code Quality Report

❌ Merging this PR will decrease code quality in the affected files by 0.31%.

Quality metrics	Before	After	Change
Complexity	0.00 ⭐	0.00 ⭐	0.00
Method Length	108.33 🙂	111.67 🙂	3.34 👎
Working memory	5.88 ⭐	5.94 ⭐	0.06 👎
Quality	78.75% ⭐	78.44% ⭐	-0.31% 👎

Other metrics	Before	After	Change
Lines	131	135	4

Changed files	Quality Before	Quality After	Quality Change
nlp_profiler/constants.py	80.50% ⭐	80.17% ⭐	-0.33% 👎
nlp_profiler/granular_features/init.py	51.29% 🙂	50.77% 🙂	-0.52% 👎

Here are some functions in these files that still need a tune-up:

File	Function	Complexity	Length	Working Memory	Quality	Recommendation
nlp_profiler/granular_features/init.py	apply_granular_features	0 ⭐	114 🙂	53 ⛔	50.77% 🙂	Extract out complex expressions

Legend and Explanation

The emojis denote the absolute quality of the code:

⭐ excellent
🙂 good
😞 poor
⛔ very poor

The 👍 and 👎 indicate whether the quality has improved or gotten worse with this pull request.

Please see our documentation here for details on how these metrics are calculated.

We are actively working on this report - lots more documentation and extra metrics to come!

Let us know what you think of it by mentioning @sourcery-ai in a comment.

neomatrix369 / nlp_profiler