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

Silent doc failures not being detected #649

Open
jkirk5 opened this issue Jan 22, 2025 · 0 comments
Open

Silent doc failures not being detected #649

jkirk5 opened this issue Jan 22, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@jkirk5
Copy link
Contributor

jkirk5 commented Jan 22, 2025

Desired documentation content.

Building the docs currently only checks for complete failures and errors, however there are issues that can occur that do not cause the cell to completely fail, but can produce the wrong answer. A current example of this is additional_flight_phases.ipynb, where a number of runtime warnings pop up. This is both concerning for a user reading the docs who doesn't know if these warnings are serious or not, and could lead to a doc showing the incorrect answer for an example.

We need to start baking asserts and other checks similar to our unittests and benchmark tests into doc cells (probably separate hidden cells) so we immediately know if something changed

Is there any existing documentation on your requested topic? Please describe.

No response

@jkirk5 jkirk5 added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant