This is an automated email from the ASF dual-hosted git repository.
jorisvandenbossche 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 082b11e ARROW-13239: [Python] [Doc] Expose signatures in pyx modules
082b11e is described below
commit 082b11e9ecb4acd60d2e36ba8b5b3bda8b2027ce
Author: Alessandro Molina <[email protected]>
AuthorDate: Fri Jul 16 13:36:54 2021 +0200
ARROW-13239: [Python] [Doc] Expose signatures in pyx modules
Closes #10684 from amol-/ARROW-13239
Authored-by: Alessandro Molina <[email protected]>
Signed-off-by: Joris Van den Bossche <[email protected]>
---
cpp/cmake_modules/UseCython.cmake | 2 ++
python/pyarrow/_csv.pyx | 1 -
python/pyarrow/_feather.pyx | 1 -
python/pyarrow/_flight.pyx | 1 -
python/pyarrow/_json.pyx | 1 -
python/pyarrow/_orc.pyx | 1 -
python/pyarrow/_parquet.pyx | 1 -
python/pyarrow/_plasma.pyx | 1 -
python/pyarrow/gandiva.pyx | 1 -
python/pyarrow/lib.pyx | 1 -
10 files changed, 2 insertions(+), 9 deletions(-)
diff --git a/cpp/cmake_modules/UseCython.cmake
b/cpp/cmake_modules/UseCython.cmake
index 0b65a78..f2025ef 100644
--- a/cpp/cmake_modules/UseCython.cmake
+++ b/cpp/cmake_modules/UseCython.cmake
@@ -145,6 +145,8 @@ function(compile_pyx
${no_docstrings_arg}
${cython_debug_arg}
${CYTHON_FLAGS}
+ # Necessary for autodoc of function arguments
+ --directive embedsignature=True
# Necessary for Cython code coverage
--working
${CMAKE_CURRENT_SOURCE_DIR}
diff --git a/python/pyarrow/_csv.pyx b/python/pyarrow/_csv.pyx
index 1e896a2..2b7a835 100644
--- a/python/pyarrow/_csv.pyx
+++ b/python/pyarrow/_csv.pyx
@@ -17,7 +17,6 @@
# cython: profile=False
# distutils: language = c++
-# cython: embedsignature = True
# cython: language_level = 3
from cython.operator cimport dereference as deref
diff --git a/python/pyarrow/_feather.pyx b/python/pyarrow/_feather.pyx
index 2f46bb9..8df7935 100644
--- a/python/pyarrow/_feather.pyx
+++ b/python/pyarrow/_feather.pyx
@@ -20,7 +20,6 @@
# cython: profile=False
# distutils: language = c++
-# cython: embedsignature = True
# cython: language_level=3
from cython.operator cimport dereference as deref
diff --git a/python/pyarrow/_flight.pyx b/python/pyarrow/_flight.pyx
index 618291c..c3536a6 100644
--- a/python/pyarrow/_flight.pyx
+++ b/python/pyarrow/_flight.pyx
@@ -16,7 +16,6 @@
# under the License.
# cython: language_level = 3
-# cython: embedsignature = True
import collections
import contextlib
diff --git a/python/pyarrow/_json.pyx b/python/pyarrow/_json.pyx
index ef2567a..183bd4f 100644
--- a/python/pyarrow/_json.pyx
+++ b/python/pyarrow/_json.pyx
@@ -17,7 +17,6 @@
# cython: profile=False
# distutils: language = c++
-# cython: embedsignature = True
# cython: language_level = 3
from pyarrow.includes.common cimport *
diff --git a/python/pyarrow/_orc.pyx b/python/pyarrow/_orc.pyx
index d045720..f58b52a 100644
--- a/python/pyarrow/_orc.pyx
+++ b/python/pyarrow/_orc.pyx
@@ -17,7 +17,6 @@
# cython: profile=False
# distutils: language = c++
-# cython: embedsignature = True
from cython.operator cimport dereference as deref
from libcpp.vector cimport vector as std_vector
diff --git a/python/pyarrow/_parquet.pyx b/python/pyarrow/_parquet.pyx
index 0b66ea0..f229a27 100644
--- a/python/pyarrow/_parquet.pyx
+++ b/python/pyarrow/_parquet.pyx
@@ -17,7 +17,6 @@
# cython: profile=False
# distutils: language = c++
-# cython: embedsignature = True
import io
from textwrap import indent
diff --git a/python/pyarrow/_plasma.pyx b/python/pyarrow/_plasma.pyx
index e2c5317..e38c81f 100644
--- a/python/pyarrow/_plasma.pyx
+++ b/python/pyarrow/_plasma.pyx
@@ -17,7 +17,6 @@
# cython: profile=False
# distutils: language = c++
-# cython: embedsignature = True
# cython: language_level = 3
from libcpp cimport bool as c_bool, nullptr
diff --git a/python/pyarrow/gandiva.pyx b/python/pyarrow/gandiva.pyx
index 61e2587..12d572b 100644
--- a/python/pyarrow/gandiva.pyx
+++ b/python/pyarrow/gandiva.pyx
@@ -18,7 +18,6 @@
# cython: profile=False
# distutils: language = c++
# cython: language_level = 3
-# cython: embedsignature = True
from libcpp cimport bool as c_bool, nullptr
from libcpp.memory cimport shared_ptr, unique_ptr, make_shared
diff --git a/python/pyarrow/lib.pyx b/python/pyarrow/lib.pyx
index fdf1696..60e1f8c 100644
--- a/python/pyarrow/lib.pyx
+++ b/python/pyarrow/lib.pyx
@@ -16,7 +16,6 @@
# under the License.
# cython: profile = False
-# cython: embedsignature = True
# cython: nonecheck = True
# distutils: language = c++
