Add some more documentation of functions

[BradyAJohnston]

• more details to some docs
• update readme

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.35%. Comparing base (96abef6) to head (1556c98).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #27      +/-   ##
==========================================
+ Coverage   68.78%   71.35%   +2.57%     
==========================================
  Files           9        9              
  Lines         567      569       +2     
==========================================
+ Hits          390      406      +16     
+ Misses        177      163      -14     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.