[russbiggs]

updates @return roxygen for CRAN and adds some consistency to other docs

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.07%. Comparing base (34f4fa7) to head (923dde5).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #29   +/-   ##
=======================================
  Coverage   95.06%   95.07%           
=======================================
  Files          13       13           
  Lines        1115     1117    +2     
=======================================
+ Hits         1060     1062    +2     
  Misses         55       55           

☔ 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.