Docs

[jmafoster1]

Temporary fix to address this JOSS reviewer comment while we overhaul the docs.

[github-actions]

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
✅ PYTHON	black	31		0	1.03s
✅ PYTHON	pylint	31		0	6.56s

See detailed report in MegaLinter reports

MegaLinter is graciously provided by

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.59%. Comparing base (f10437d) to head (4dcaf21).
Report is 6 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #314   +/-   ##
=======================================
  Coverage   93.59%   93.59%           
=======================================
  Files          27       27           
  Lines        1577     1577           
=======================================
  Hits         1476     1476           
  Misses        101      101           

---

Continue to review full report in Codecov by Sentry.

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

🚀 New features to boost your workflow:

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

[f-allian]

👍🏼