ksuarez1423 commented on code in PR #14185: URL: https://github.com/apache/arrow/pull/14185#discussion_r981387373
########## docs/source/cpp/acero_overview.rst: ########## @@ -0,0 +1,29 @@ +.. Licensed to the Apache Software Foundation (ASF) under one +.. or more contributor license agreements. See the NOTICE file +.. distributed with this work for additional information +.. regarding copyright ownership. The ASF licenses this file +.. to you under the Apache License, Version 2.0 (the +.. "License"); you may not use this file except in compliance +.. with the License. You may obtain a copy of the License at + +.. http://www.apache.org/licenses/LICENSE-2.0 + +.. Unless required by applicable law or agreed to in writing, +.. software distributed under the License is distributed on an +.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +.. KIND, either express or implied. See the License for the +.. specific language governing permissions and limitations +.. under the License. + +***** +Acero +***** + +.. toctree:: + :maxdepth: 3 + + acero/overview Review Comment: Putting the overview in its entirety, including how to make an ExecPlan, before discussing Substrait increases the risk that a user will use an ExecPlan by hand instead of using Substrait as a helper layer. Could overview be broken up further, and one part put before Substrait and one after? Really, it seems what's necessary is a good example of using Substrait to make one of these trees -- right now, all we offer is how to do it directly, which is really helpful for some developers, but drives them away from Substrait. ########## docs/source/cpp/getting_started.rst: ########## @@ -24,25 +24,27 @@ Getting Started The following articles demonstrate installation, use, and a basic understanding of Arrow. These articles will get you setup quickly using Arrow and give you a taste of what the library is capable of. -Specifically, it contains: an installation and linking guide; documentation of conventions used -in the codebase and suggested for users; and tutorials, including: +Specifically, it contains: an installation and linking guide; documentation of conventions used +in the codebase and suggested for users; and tutorials, including: -* Building Arrow arrays and tabular structures +* Building Arrow arrays and tabular structures * Reading and writing Parquet, Arrow, and CSV files * Executing compute kernels on arrays * Reading and writing multi-file partitioned datasets Start here to gain a basic understanding of Arrow, and move on to the :doc:`/cpp/user_guide` to -explore more specific topics and underlying concepts, or the :doc:`/cpp/api` to explore Arrow's -API. +explore more specific topics and underlying concepts, or the :doc:`/cpp/api` to explore Arrow's +API. .. toctree:: + overview build_system conventions tutorials/basic_arrow.rst tutorials/io_tutorial.rst tutorials/compute_tutorial.rst tutorials/datasets_tutorial.rst - - + acero_overview Review Comment: These should go in User's Guide -- it's all very technical, and not tutorial-shaped. -- 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]
