-
Notifications
You must be signed in to change notification settings - Fork 656
docs: improve docstrings on methods using the database
param
#11112
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
Conversation
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.
Thanks for improving the docs, @NickCrews ! One (copy-pasted) spelling error to fix, and I think we should case DuckDB
when using it in prose.
I also need to check if ipython
style "superhelp" correctly pulls docstrings from the parent class (I'm pretty sure it does, but I remember some issues a while back)
Update: superhelp works just fine.
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.
Great work, thanks!
The PR title and description conform to the Conventional Commits specification. |
e364f80
to
6e4909c
Compare
d20e674
to
2d80b4f
Compare
To get the datafusion tests to pass, I had to dig into getting the current database and catalog for datafusion. I ended up implementing this, and adding |
@NickCrews This seems to break a lot of datafusion functionality for reasons that are unclear to me. |
2d80b4f
to
1391c58
Compare
…atalog or database param of list_tables()
This was breaking tests because it all of a sudden made impala get run for some tests, but this functionality isn't implemented. I will do this in a different PR.
This is breaking.
Thank you! |
I removed many docstrings from subclasses, which should lead to them inheriting the docstring of the base class. This should make the docstrings easier to maintain and less lilely to drift.
I also linked to the concepts doc that @gforsyth wrote, but that never was included in the index or linked to anywhere. I think it should be surfaced somewhere more obvious.