-
Notifications
You must be signed in to change notification settings - Fork 22
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
Use Sybil for doctests #142
Conversation
Signed-off-by: nstarman <nstarman@users.noreply.github.com>
Signed-off-by: nstarman <nstarman@users.noreply.github.com>
Hmm. This passes on py3.12 on my local version. |
Signed-off-by: nstarman <nstarman@users.noreply.github.com>
Signed-off-by: nstarman <nstarman@users.noreply.github.com>
Signed-off-by: nstarman <nstarman@users.noreply.github.com>
Pull Request Test Coverage Report for Build 8786086897Details
💛 - Coveralls |
I think the failure is unrelated |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks awesome, @nstarman. Thank you so much for this!
I've got a few very minor comments/questions, which I left as comment in the PR.
Again, this is a fantastic PR, @nstarman! Merging this right away. :) Thanks so much!! |
This PR add docstring testing and testing of the docs via Sybil (https://sybil.readthedocs.io/en/latest/).
I'm not sure what style of docstrings you want... My last PR was in the NumPy style, but the rest of the docs are in Google's...
If you don't like the
try: ...; ... except Exception as e: print(f"{type(e).__name__}: {e}")
, I think we can subclasssybil.parsers.myst.PythonCodeBlockParser
and modify it so that thetry: except
operates behind the scenes. IMO I like that it's explicit and the examples are safer to copy-paste.Found:
__module__ is None
Squash merge is fine!