adamreeve commented on code in PR #49489: URL: https://github.com/apache/arrow/pull/49489#discussion_r2915007171
########## docs/source/cpp/security.rst: ########## @@ -0,0 +1,142 @@ +.. 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. + +.. default-domain:: cpp + +.. _cpp-security: + +======================= +Security Considerations +======================= + +.. important:: + This document describes the security model for using the Arrow C++ APIs. + For better understanding of this document, we recommend that you first read + the :ref:`overall security model <format_security>` for the Arrow project. + +Parameter mismatch +================== + +Many Arrow C++ APIs report errors using the :class:`arrow::Status` and +:class:`arrow::Result`. Such APIs can be assumed to detect common errors in the Review Comment: ```suggestion :class:`arrow::Result` types. Such APIs can be assumed to detect common errors in the ``` ########## docs/source/cpp/security.rst: ########## @@ -0,0 +1,142 @@ +.. 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. + +.. default-domain:: cpp + +.. _cpp-security: + +======================= +Security Considerations +======================= + +.. important:: + This document describes the security model for using the Arrow C++ APIs. + For better understanding of this document, we recommend that you first read + the :ref:`overall security model <format_security>` for the Arrow project. + +Parameter mismatch +================== Review Comment: The `Data Validity` and `"Safe" and "unsafe" APIs` sections are nested under this `Parameter mismatch` section, but they seem like they should be separate top-level sections to me. -- 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]
