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

Tidying up! Add doctests #51

Merged
merged 2 commits into from
Oct 22, 2024
Merged

Tidying up! Add doctests #51

merged 2 commits into from
Oct 22, 2024

Conversation

sneakers-the-rat
Copy link
Contributor

Love the reorganization in #48

Noticed that a bunch of the pages were not showing up in the toctree, so i went to add them, and i noticed that there were an avalanche of warnings that probably makes it hard to tell what is actually a meaningful warning and what is just noise, so i also fixed all those.

Not a contentful PR, but things to note:

  • I switched the docs build to docs-test so we can help ourselves out by alerting us to when links are broken/etc. and fix them as we go. we can disable that if people find it annoying, i personally find it helpful because i always forget to check before i push.
  • I renamed the python-conditionals link target to just conditionals because there was an ambiguity error (i assume since the file is named python-conditionals.md)
  • I added raises-exceptions tags to all the python notebook cells that were failing, most of them you had explicitly written that they should fail around them, but there were some where i wasn't sure, so if there are any i marked here that aren't supposed to fail then those probs need to be fixed :)

Copy link
Member

@lwasser lwasser left a comment

Choose a reason for hiding this comment

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

oh gosh - @sneakers-the-rat THANK YOU for this! i saw all of the warnings but i haven't had time to focus on them. this is awesome. thank you! also the doc-test idea is a great one.

@lwasser lwasser merged commit ffaf353 into main Oct 22, 2024
4 checks passed
@sneakers-the-rat
Copy link
Contributor Author

also feel free to ignore the errors if you're getting into crunch time prepping for the workshop but you already know that ;)

@lwasser lwasser deleted the tidying-jls branch October 22, 2024 23:30
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