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

Improve doctest handling #1800

Open
yaugenst-flex opened this issue Jul 4, 2024 · 0 comments
Open

Improve doctest handling #1800

yaugenst-flex opened this issue Jul 4, 2024 · 0 comments
Assignees

Comments

@yaugenst-flex
Copy link
Collaborator

Currently, doctests are not executed by runners, which can lead to deterioration of our docstring examples over time. The main issue is that for some examples, doctests might be annoying to set up properly, two cases in particular seem common (see #1797 and #1798 for example):

  1. Setting up a full tidy3d simulation just to show an example for one simple API call
  2. Docstrings failing because of logged warnings

So currently we solve 1. by either just setting up the simulation or skipping the test, and for 2. we basically just skip the test.
It would be good to find a way to do this without having to skip the tests altogether.

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

No branches or pull requests

2 participants