Skip to content

Make unit test helpers file into a public submodule #812

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

Merged
merged 2 commits into from
Apr 10, 2025

Conversation

tskisner
Copy link
Member

@tskisner tskisner commented Apr 7, 2025

  • Delete old tutorial directory
  • Move mkdocs to final docs location
  • Add github workflow for deploying docs
  • Convert _helpers.py into a submodule. Small tweaks to create_outdir helper.
  • Change imports across all unit tests
  • Run format_source.sh

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@tskisner tskisner requested a review from keskitalo April 8, 2025 23:29
@tskisner
Copy link
Member Author

tskisner commented Apr 8, 2025

This PR has many trivial changes, mostly moving and deleting files.

@tskisner tskisner marked this pull request as ready for review April 8, 2025 23:31
Copy link
Member

@keskitalo keskitalo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have a lot of unit tests!

The fact that we are importing methods from the interactive module in every unit test has me wondering if the module name is descriptive or not. Obviously not an issue for this PR.

@tskisner
Copy link
Member Author

Summarizing offline discussion:

  • The toast.interactive module should contain just things intended to run from a notebook (i.e. that require ipython)
  • The rest of the "helper" functions that setup synthetic test cases are primarily useful for the unit tests, even if we also want to use them for documentation tutorials. For this code, it is fine to just make a public toast.tests.helpers module that replaces the old, large _helpers.py. In principle this could also grow to include more "cook book" style involved examples- since we want to test that code as well.
  • I will do this rearranging and rebase / squash to reduce the noise in this PR.

- Delete old tutorial directory

- Move mkdocs to final docs location

- Add github workflow for deploying docs

- Convert _helpers.py into a submodule.  Small tweaks
  to create_outdir helper.

- Change imports across all unit tests

- Run format_source.sh
@tskisner tskisner changed the title Change unit tests to use new interactive module Make unit test helpers file into a public submodule Apr 10, 2025
@tskisner tskisner merged commit dedffb2 into toast3 Apr 10, 2025
7 checks passed
@tskisner tskisner deleted the test_interactive branch April 10, 2025 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants