thisisnic commented on a change in pull request #11677: URL: https://github.com/apache/arrow/pull/11677#discussion_r758425137
########## File path: docs/source/developers/guide/architectural_overview.rst ########## @@ -0,0 +1,40 @@ +.. 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. + + +.. SCOPE OF THIS SECTION +.. This section should include architectural overview +.. of the Arrow project. If possible the content should be +.. written in words easy understandable to beginner not +.. necessary acquainted with the library and the technical +.. details. + +.. _architectural_overview: + +********************** +Architectural Overview +********************** + +A general overview of Apache Arrow project can be found on the +`front page <https://arrow.apache.org/>`_ and in the +`Apache Arrow Overview <https://arrow.apache.org/overview/>`_. + +For an Architectural Overview of Arrow's libraries please +refer to: + +- PyArrow Architectural Overview +- R-Arrow Architectural Overview Review comment: The reason I made this suggestion is that in R we just call the R package `arrow`, but using that here would be pretty unhelpful given the rest of the document talks about multiple Arrow implementations and not just the R one :) "R-Arrow" is not a name which would be familiar to R users of Arrow. -- 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]
