You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by ko...@apache.org on 2022/06/12 14:11:32 UTC
[arrow] branch master updated: MINOR: [Python][Docs] Fix typo and add Returns for new_file/new_stream (#13369)
This is an automated email from the ASF dual-hosted git repository.
kou pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/master by this push:
new 87e32e6990 MINOR: [Python][Docs] Fix typo and add Returns for new_file/new_stream (#13369)
87e32e6990 is described below
commit 87e32e6990620f8644da7930c4b516c5126f0588
Author: Saul Pwanson <co...@saul.pw>
AuthorDate: Sun Jun 12 07:11:27 2022 -0700
MINOR: [Python][Docs] Fix typo and add Returns for new_file/new_stream (#13369)
Lead-authored-by: Saul Pwanson <sa...@voltrondata.com>
Co-authored-by: Sutou Kouhei <ko...@cozmixng.org>
Signed-off-by: Sutou Kouhei <ko...@clear-code.com>
---
docs/source/python/getstarted.rst | 4 ++--
python/pyarrow/ipc.py | 14 ++++++++++++--
2 files changed, 14 insertions(+), 4 deletions(-)
diff --git a/docs/source/python/getstarted.rst b/docs/source/python/getstarted.rst
index 4f134f2a26..d38fcadab2 100644
--- a/docs/source/python/getstarted.rst
+++ b/docs/source/python/getstarted.rst
@@ -148,8 +148,8 @@ and will lazily load chunks of data only when iterating over them
For further details on how to work with big datasets, how to filter them,
how to project them, etc., refer to :ref:`dataset` documentation.
-Continuining from here
-----------------------
+Continuing from here
+--------------------
For digging further into Arrow, you might want to read the
:doc:`PyArrow Documentation <./index>` itself or the
diff --git a/python/pyarrow/ipc.py b/python/pyarrow/ipc.py
index 3eaa239f35..0e08bb3e58 100644
--- a/python/pyarrow/ipc.py
+++ b/python/pyarrow/ipc.py
@@ -157,7 +157,12 @@ def new_stream(sink, schema, *, use_legacy_format=None, options=None):
new_stream.__doc__ = """\
Create an Arrow columnar IPC stream writer instance
-{}""".format(_ipc_writer_class_doc)
+{}
+
+Returns
+-------
+writer : RecordBatchStreamWriter
+""".format(_ipc_writer_class_doc)
def open_stream(source, *, options=None, memory_pool=None):
@@ -190,7 +195,12 @@ def new_file(sink, schema, *, use_legacy_format=None, options=None):
new_file.__doc__ = """\
Create an Arrow columnar IPC file writer instance
-{}""".format(_ipc_writer_class_doc)
+{}
+
+Returns
+-------
+writer : RecordBatchFileWriter
+""".format(_ipc_writer_class_doc)
def open_file(source, footer_offset=None, *, options=None, memory_pool=None):