alamb opened a new pull request, #11290: URL: https://github.com/apache/datafusion/pull/11290
## Which issue does this PR close? Part of https://github.com/apache/datafusion/issues/11172 ## Rationale for this change I am trying to make the documentation better and examples easier to find I would like to consolidate the examples for using DataFrames from examples https://github.com/apache/datafusion/tree/main/datafusion-examples/examples (e.g [dataframe.rs](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/dataframe.rs) and [dataframe_in_memory](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/dataframe_in_memory.rs) and [dataframe_output](https://github.com/apache/datafusion/blob/main/datafusion-examples/examples/dataframe_output.rs) However, first I wanted to make sure that the existing DataFrame API docs were in good shape -- and it turns out they needed some attention to get the examples compiling So to keep the size of this PR small, I started with some improvements to the initial content. I will actually consolidate some of the dataframe examples in a follow on PR ## What changes are included in this PR? 1. Run examples as part of doctests 2. Make examples run 3. Improve dataframe documentation while I was in there ## Are these changes tested? Yes, now these examples run as part of the CI <!-- We typically require tests for all PRs in order to: 1. Prevent the code from being accidentally broken by subsequent changes 5. Serve as another way to document the expected behavior of the code If tests are not included in your PR, please explain why (for example, are they covered by existing tests)? --> ## Are there any user-facing changes? <!-- If there are user-facing changes then we may require documentation to be updated before approving the PR. --> <!-- If there are any breaking changes to public APIs, please add the `api change` label. --> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
