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

Add Test Docs #161

Closed
nsryan2 opened this issue Feb 23, 2024 · 1 comment · Fixed by #173
Closed

Add Test Docs #161

nsryan2 opened this issue Feb 23, 2024 · 1 comment · Fixed by #173

Comments

@nsryan2
Copy link
Member

nsryan2 commented Feb 23, 2024

The docs from #158 do not include documentation for the tests in scripts/tests. This issue can be closed when those tests are documented, and instructions on how to run the tests is added.

@nsryan2
Copy link
Member Author

nsryan2 commented Aug 1, 2024

Step 1:
Make sure all of the test functions have docstrings.
Step 2:
Make a folder called test_docs inside docs
Step 3:
Make a test_script.rst for each test script
Step 4:
Copy the first two parts of https://github.com/arfc/transition-scenarios/blob/master/docs/index.md?plain=1 and paste into a new file called test_index.rst
Step 5:
Update all the names for the test scripts
Step 6:
Add test_index.rst to index.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant