PIMS-1883 Code Commenting Spree

[dbarkowsky]

🎯 Summary

PIMS-1883

Changes

• Mostly adding a lot of code comments where missing
  • Focused on the API. Looking at the React components, it didn't seem like comments made as much sense there
• Removed a few instances of code that wasn't up to date and also not used anywhere

🔰 Checklist

• I have read and agree with the following checklist and am following the guidelines in our Code of Conduct document.

• I have performed a self-review of my code.
• I have commented my code, particularly in hard-to-understand areas.
• I have made corresponding changes to the documentation where required.
• I have tested my changes to the best of my ability.
• My changes generate no new warnings.

[codeclimate]

Code Climate has analyzed commit 5ed488c and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 92.5%.

View more on Code Climate.

[TaylorFries]

documentation looks great!