You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2022/03/28 18:37:28 UTC

[GitHub] [arrow] lidavidm opened a new pull request #12737: ARROW-16046: [Docs][FlightRPC][Python] Ensure Flight Python API is documented

lidavidm opened a new pull request #12737:
URL: https://github.com/apache/arrow/pull/12737


   Add some missing classes to the docs, also fix a couple build warnings.


-- 
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] lidavidm commented on a change in pull request #12737: ARROW-16046: [Docs][FlightRPC][Python] Ensure Flight Python API is documented

Posted by GitBox <gi...@apache.org>.
lidavidm commented on a change in pull request #12737:
URL: https://github.com/apache/arrow/pull/12737#discussion_r837676319



##########
File path: docs/source/java/vector_schema_root.rst
##########
@@ -109,7 +109,7 @@ Here is the example of building a :class:`VectorSchemaRoot`
 
 The vectors within a :class:`VectorSchemaRoot` could be loaded/unloaded via :class:`VectorLoader` and :class:`VectorUnloader`.
 :class:`VectorLoader` and :class:`VectorUnloader` handles converting between :class:`VectorSchemaRoot` and :class:`ArrowRecordBatch` (
-representation of a RecordBatch :doc:`IPC <../format/IPC.rst>` message). Examples as below
+representation of a RecordBatch :doc:`IPC <../format/IPC>` message). Examples as below

Review comment:
       Thanks, I gave this section a quick pass and did some copyediting in general




-- 
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] github-actions[bot] commented on pull request #12737: ARROW-16046: [Docs][FlightRPC][Python] Ensure Flight Python API is documented

Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #12737:
URL: https://github.com/apache/arrow/pull/12737#issuecomment-1081137508






-- 
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] jorisvandenbossche commented on a change in pull request #12737: ARROW-16046: [Docs][FlightRPC][Python] Ensure Flight Python API is documented

Posted by GitBox <gi...@apache.org>.
jorisvandenbossche commented on a change in pull request #12737:
URL: https://github.com/apache/arrow/pull/12737#discussion_r837202180



##########
File path: docs/source/java/vector_schema_root.rst
##########
@@ -109,7 +109,7 @@ Here is the example of building a :class:`VectorSchemaRoot`
 
 The vectors within a :class:`VectorSchemaRoot` could be loaded/unloaded via :class:`VectorLoader` and :class:`VectorUnloader`.
 :class:`VectorLoader` and :class:`VectorUnloader` handles converting between :class:`VectorSchemaRoot` and :class:`ArrowRecordBatch` (
-representation of a RecordBatch :doc:`IPC <../format/IPC.rst>` message). Examples as below
+representation of a RecordBatch :doc:`IPC <../format/IPC>` message). Examples as below

Review comment:
       This file is no longer containing the actual contents, so pointing directly to the section in Columnar.rst might be better: `` :ref:`IPC <format-ipc>` ``

##########
File path: docs/source/java/vector_schema_root.rst
##########
@@ -109,7 +109,7 @@ Here is the example of building a :class:`VectorSchemaRoot`
 
 The vectors within a :class:`VectorSchemaRoot` could be loaded/unloaded via :class:`VectorLoader` and :class:`VectorUnloader`.
 :class:`VectorLoader` and :class:`VectorUnloader` handles converting between :class:`VectorSchemaRoot` and :class:`ArrowRecordBatch` (
-representation of a RecordBatch :doc:`IPC <../format/IPC.rst>` message). Examples as below
+representation of a RecordBatch :doc:`IPC <../format/IPC>` message). Examples as below

Review comment:
       ```suggestion
   representation of a RecordBatch :ref:`IPC <format-ipc>` message). Examples as below
   ```

##########
File path: python/pyarrow/_flight.pyx
##########
@@ -1168,6 +1173,10 @@ cdef class FlightClient(_Weakrefable):
     def connect(cls, location, tls_root_certs=None, cert_chain=None,
                 private_key=None, override_hostname=None,
                 disable_server_verification=None):
+        """Connect to a Flight server.
+
+        .. deprecated:: 0.15.0

Review comment:
       ```suggestion
           .. deprecated:: 0.15.0
               Use the ``FlightClient`` constructor or ``pyarrow.flight.connect`` function instead.
   ```

##########
File path: python/pyarrow/_flight.pyx
##########
@@ -2595,6 +2761,10 @@ cdef class FlightServerBase(_Weakrefable):
             check_flight_status(self.server.get().ServeWithSignals())
 
     def run(self):
+        """Block until the server shuts down.
+
+        .. deprecated:: 0.15.0

Review comment:
       ```suggestion
           .. deprecated:: 0.15.0
               Use the ``FlightServer.serve`` method instead
   ```




-- 
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