alamb opened a new pull request, #11324:
URL: https://github.com/apache/datafusion/pull/11324

   ## Which issue does this PR close?
   
   Part of #3058 
   
   ## Rationale for this change
   
   While responding to comments from @efredine on 
https://github.com/apache/datafusion/pull/11290, I noticed some other ways the 
`DataFrame`  docs could be improved
   
   Specifically this page: 
https://datafusion.apache.org/user-guide/dataframe.html
   
   Among other things, the examples are incomplete (and they are not run in CO) 
and the documentation of methods is also incomplete
   
   ## What changes are included in this PR?
   
   1. Run the examples as part of the doctests
   2. Remove the duplicate API documentation, and instead point people at the 
API docs
   2. Add a link to the library user guide docs on 
https://datafusion.apache.org/library-user-guide/using-the-dataframe-api.html  
(improved in https://github.com/apache/datafusion/pull/11290)
   
   ## Are these changes tested?
   
   The examples are now tested as part of CI, 
   
   
   I also built the docs locally and I think they look better:
   
   ![Screenshot 2024-07-07 at 5 31 36 
PM](https://github.com/apache/datafusion/assets/490673/c529bbed-0f45-44fa-8c92-10697fcc1e30)
   
   ## 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]

Reply via email to