Skip to content

Make Test Doc Strings Generic and Consistent #561

@weibullguy

Description

@weibullguy

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:

  1. 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.).
  2. Apply these generic docstrings to all the tests in the RAMSTK test suite.

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueGood issue to get your feet wet...mostly busy work :(priority: lowIssue or PR is low priority.status: backlogIssue or PR is open, unmilestoned, and unassigned.type: testIssue or PR associated with RAMSTK test suite.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions