You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "alamb (via GitHub)" <gi...@apache.org> on 2023/06/06 14:02:39 UTC

[GitHub] [arrow-datafusion] alamb opened a new pull request, #6564: Improve main api doc page

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

   # Which issue does this PR close?
   Related to #3058 
   
   # Rationale for this change
   
   The main docs landing page is somewhat messy and inconsistent. I would like this to be better when users try to use DataFusion
   
   <img width="1265" alt="Screenshot 2023-06-06 at 9 21 53 AM" src="https://github.com/apache/arrow-datafusion/assets/490673/e03e8a57-c938-4927-8c89-10e144fdf8cb">
   
   
   
   
   # What changes are included in this PR?
   Clean up docs and move the `avro_to_arrow` module into `datasource` as it is somewhat specialized
   
   <img width="1014" alt="Screenshot 2023-06-06 at 10 00 51 AM" src="https://github.com/apache/arrow-datafusion/assets/490673/f09b5639-5455-453e-8964-6925b6569a01">
   
   <!--
   There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
   -->
   
   # Are these changes tested?
   
   <!--
   We typically require tests for all PRs in order to:
   1. Prevent the code from being accidentally broken by subsequent changes
   2. 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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow-datafusion] alamb commented on pull request #6564: Improve main api doc page

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #6564:
URL: https://github.com/apache/arrow-datafusion/pull/6564#issuecomment-1581272194

   (I am in parallel working to remove `FromSlice` as well -- https://github.com/apache/arrow-datafusion/pull/6587)


-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow-datafusion] alamb commented on pull request #6564: Improve main api doc page, move `avro_to_arrow` to `datasource`

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #6564:
URL: https://github.com/apache/arrow-datafusion/pull/6564#issuecomment-1586334199

   Thanks @avantgardnerio !


-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow-datafusion] alamb merged pull request #6564: Improve main api doc page, move `avro_to_arrow` to `datasource`

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb merged PR #6564:
URL: https://github.com/apache/arrow-datafusion/pull/6564


-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


[GitHub] [arrow-datafusion] alamb commented on a diff in pull request #6564: Improve main api doc page

Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #6564:
URL: https://github.com/apache/arrow-datafusion/pull/6564#discussion_r1219719507


##########
datafusion/core/src/lib.rs:
##########
@@ -412,7 +413,6 @@ pub const DATAFUSION_VERSION: &str = env!("CARGO_PKG_VERSION");
 extern crate core;
 extern crate sqlparser;
 
-pub mod avro_to_arrow;

Review Comment:
   Technically this is a breaking API change, but I don't expect it to be a large impact as I think the use of `avro_to_arrow` is likely small. 
   
   If it turns out others are using it more extensively, I think we should contemplate moving it to its own crate (or maybe upstream into arrow-rs)



-- 
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: github-unsubscribe@arrow.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org