ronanstokes-db commented 2 years ago

Proposed changes

Enhance text generation from Template Text Generator

Switch to vectorized implementation using Numpy / Pandas and take advantage of Numpy random number generation repeatability

This PR implements repeatable vectorized implementation of TemplateTextGenerator

It also expands coverage of text generators substantially

Types of changes

What types of changes does your code introduce to dbldatagen? Put an x in the boxes that apply

[x] Bug fix (non-breaking change which fixes an issue)
[x] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[x] Change to tutorials, tests or examples
[ ] Non code change (readme, images or other non-code assets)
[ ] Documentation Update (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

[x] Lint and unit tests pass locally with my changes
[x] I have added tests that prove my fix is effective or that my feature works
[x] I have added necessary documentation (if appropriate)
[x] Any dependent changes have been merged and published in downstream modules
[x] Submission does not reduce code coverage numbers
[x] Submission does not increase alerts or messages from LGTM

Further comments

If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

codecov[bot] commented 2 years ago

Codecov Report

Merging #132 (2959c26) into master (aea3f84) will increase coverage by 2.58%. The diff coverage is 96.75%.

@@            Coverage Diff             @@
##           master     #132      +/-   ##
==========================================
+ Coverage   86.90%   89.49%   +2.58%     
==========================================
  Files          21       22       +1     
  Lines        2161     2332     +171     
  Branches      367      375       +8     
==========================================
+ Hits         1878     2087     +209     
+ Misses        183      160      -23     
+ Partials      100       85      -15

Impacted Files	Coverage Δ
dbldatagen/text_generators.py	`96.83% <96.75%> (+17.06%)`	:arrow_up:
dbldatagen/__init__.py	`90.90% <0.00%> (ø)`

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.