docs and typing

[willmcgugan]

Fixes #3706

[codecov-commenter]

⚠️ Please install the to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.84%. Comparing base (225cb07) to head (3813c53).
Report is 67 commits behind head on master.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3775      +/-   ##
==========================================
- Coverage   98.24%   97.84%   -0.40%     
==========================================
  Files          74       74              
  Lines        8105     8136      +31     
==========================================
- Hits         7963     7961       -2     
- Misses        142      175      +33     

Flag	Coverage Δ
unittests	97.84% <ø> (-0.40%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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