ramstk
ramstk copied to clipboard
Make Test Doc Strings Generic and Consistent
Describe the test that is missing or needs to be fixed.
Test method docstrings are meaningless as the result of copy-paste ad naseum. Two things need to be accomplished:
- Define docstrings for each test that is duplicated across RAMSTK modules so they don't reference a particular RAMSTK module's components (e.g., Similar Item, RAMSTKControl, ramstkhardware, etc.).
- Apply these generic docstrings to all the tests in the RAMSTK test suite.
- [X] This issue is an epic issue which subsumes the following: #578
See docstrings in Allocation, Hazards, Mode, Program Status, Similar Item, Stakeholder, and Validation tests. These have been made to be consistent and are acceptable in format and content.