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
Start with dask-expr doc build #10879
Conversation
Unit Test ResultsSee test report for an extended history of previous test failures. This is useful for diagnosing flaky tests. 15 files ±0 15 suites ±0 3h 10m 33s ⏱️ + 2m 43s For more details on these failures, see this check. Results for commit 1c6e54e. ± Comparison against base commit 1b711be. ♻️ This comment has been updated with latest results. |
I've had to define a few accessors explicitly, since sphinx confused the DataFrame classes from Dask-expr and dask/dask without them. This is a known issue see sphinx-doc/sphinx#4961 |
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 @phofl -- overall this LGTM. I left a few comments, the main one I care about is the new API page being top-level in the DataFrame toc. All the other comments are just non-blocking suggestions.
Dask DataFrame API with Logical Query Planning | ||
============================================== |
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.
It might be nice to add a few sentences here about the query planning effort and how to enable it. I don't mean this as a blocking comment -- we can always follow-up later, or not at all
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.
Yes I intend to add content as we go before the new release is out
docs/source/dataframe.rst
Outdated
@@ -12,6 +12,7 @@ Dask DataFrame | |||
Internal Design <dataframe-design.rst> | |||
Best Practices <dataframe-best-practices.rst> | |||
API <dataframe-api.rst> | |||
API Query Planning <dask-expr-api.rst> |
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.
My sense is this is too top-level at the moment. I'd recommend moving this into the "Additional Information" dropdown for now unless there's a specific reason it needs to be top-level.
If it does need to be top-level, then we'll probably want more information about the query planning effort more generally that answers questions like "What is it?", "Why should I care?", "How do I enable it?", etc.
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.
Yeah I'll move it down, but we ideally want to add the deprecation message soonish, would move it back up then, but we will hopefully have more content by then
pre-commit run --all-files
This isn't ready to be merged, there are a couple of weird failures in the accessor docs