-
Notifications
You must be signed in to change notification settings - Fork 609
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
docs: Exception stack traces on the "Datatypes and Datashapes" page #9990
Comments
Hey @chrispy-snps -- thanks for raising this! That exception is included there by design, to show that you cannot arbitrarily combine columns from two separate relations without first joining them. The exception is so long, that I think we might benefit from not actually executing the failing cell, but sort of "faking" it and only showing the relevant portion of the traceback to improve readability. |
Thanks @gforsyth! Oops, I did not realize it was included by design - I was quickly scrolling through to look for something else, and the length threw me off. In our product's documentation, I do typically abstract away non-relevant parts of documented traced with |
automatically post-processing is probably possible, but for now we can at least just fake this one's output |
It seems like we should understand why we're showing the exception three times. We're showing:
Not all of our docstrings that show exceptions have this problem, so we should understand what's happening before hacking around it. |
For example, the |
It's probably because we're calling |
The second repr is from |
Thank you everyone! |
Please describe the issue
On the "Datatypes and Datashapes" page, there are some exception stack traces in the example results:
https://ibis-project.org/concepts/datatypes
I did not check other documentation pages for similar exceptions; that might be worth a look, if there's a programmatic way to do it.
Code of Conduct
The text was updated successfully, but these errors were encountered: