Doc updates 032523

[ronanstokes-db]

Proposed changes

Documentation reformatting

Types of changes

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

• [ ] Bug fix (non-breaking change which fixes an issue)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [ ] Change to tutorials, tests or examples
• [ ] Non code change (readme, images or other non-code assets)
• [X] 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
• [ ] I have added tests that prove my fix is effective or that my feature works
• [x] I have added necessary documentation (if appropriate)
• [ ] 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 prospector / lint

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]]

Codecov Report

Merging #181 (def2eb5) into master (1355bec) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #181   +/-   ##
=======================================
  Coverage   90.63%   90.63%           
=======================================
  Files          22       22           
  Lines        2487     2487           
  Branches      406      406           
=======================================
  Hits         2254     2254           
  Misses        150      150           
  Partials       83       83           

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