Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make Test Doc Strings Generic and Consistent #561

Open
1 task done
weibullguy opened this issue Jul 24, 2021 · 1 comment
Open
1 task done

Make Test Doc Strings Generic and Consistent #561

weibullguy opened this issue Jul 24, 2021 · 1 comment
Labels
good first issue Good issue to get your feet wet...mostly busy work :( priority: low Issue or PR is low priority. status: backlog Issue or PR is open, unmilestoned, and unassigned. type: test Issue or PR associated with RAMSTK test suite.
Milestone

Comments

@weibullguy
Copy link
Collaborator

weibullguy commented Jul 24, 2021

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.
@weibullguy weibullguy added the status: backlog Issue or PR is open, unmilestoned, and unassigned. label Jul 24, 2021
@weibullguy weibullguy added chore priority: low Issue or PR is low priority. and removed priority: low Issue or PR is low priority. labels Jul 24, 2021
@github-actions github-actions bot removed the status: backlog Issue or PR is open, unmilestoned, and unassigned. label Jul 24, 2021
@weibullguy weibullguy added status: backlog Issue or PR is open, unmilestoned, and unassigned. good first issue Good issue to get your feet wet...mostly busy work :( labels Jul 24, 2021
@weibullguy weibullguy added type: test Issue or PR associated with RAMSTK test suite. and removed chore labels Jul 24, 2021
@weibullguy weibullguy pinned this issue Jul 25, 2021
@weibullguy weibullguy unpinned this issue Jul 30, 2021
@weibullguy
Copy link
Collaborator Author

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.

@weibullguy weibullguy added this to the v1.0.0 milestone Feb 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good issue to get your feet wet...mostly busy work :( priority: low Issue or PR is low priority. status: backlog Issue or PR is open, unmilestoned, and unassigned. type: test Issue or PR associated with RAMSTK test suite.
Projects
None yet
Development

No branches or pull requests

1 participant