Clean Model Documentation

[AFg6K7h4fhy2]

This PR does several things for the MSR model documentation. Namely:

• Removes Methods from class docstrings
• Removes TODOs from Notes sections
• Creates classes for namedtuple objects
• Adjusts spelling and fixes grammatical errors
• Uses any, tuple instead of Any, Tuple from typing
• Removes Optionals from typing

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (fffbee0) to head (890eeb2).
Report is 1 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff             @@
##             main       #94      +/-   ##
===========================================
+ Coverage   90.57%   100.00%   +9.42%     
===========================================
  Files          28         2      -26     
  Lines         552         7     -545     
===========================================
- Hits          500         7     -493     
+ Misses         52         0      -52     

Flag	Coverage Δ
unittests	100.00% <ø> (+9.42%)	⬆️

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.

[gvegayon]

OK, @AFg6K7h4fhy2. I fixed it:

• We were using indexing of the tuples in some places. Since you were implementing classes from scratch, the indexing method was unavailable. I solved that using typing.NamedTuple as the base class.
• The NamedTuple class doesn't allow rewriting __init__, so instantiation is now made directly by declaring members and defaulting them to None.
• This also required how things were documented. Now, class members are declared as attributes in the docstring of the class.

[gvegayon]

LGTM