This is an automated email from the ASF dual-hosted git repository.
kou pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow.git
The following commit(s) were added to refs/heads/main by this push:
new 6068a0bf9a GH-45560: [Docs] Fix Statistics schema's "column" examples
(#45561)
6068a0bf9a is described below
commit 6068a0bf9a76f197e2f179a2d179c0a3d550601c
Author: Sutou Kouhei <[email protected]>
AuthorDate: Thu Feb 27 15:21:41 2025 +0900
GH-45560: [Docs] Fix Statistics schema's "column" examples (#45561)
### Rationale for this change
"column" in examples have duplicated values for the same column but
"column" must have only one value for each column.
### What changes are included in this PR?
* Use "rowspan" for "column" in logical examples.
* Remove duplicated values from "column" in physical examples.
* Add missing "offsets" to "statistics" in physical examples.
### Are these changes tested?
Yes.
### Are there any user-facing changes?
Yes.
* GitHub Issue: #45560
Authored-by: Sutou Kouhei <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
---
ci/conda_env_sphinx.txt | 3 +
ci/docker/conda-python-pandas.dockerfile | 2 +
docs/requirements.txt | 1 +
docs/source/conf.py | 1 +
docs/source/format/StatisticsSchema.rst | 156 ++++++++++++++-----------------
5 files changed, 75 insertions(+), 88 deletions(-)
diff --git a/ci/conda_env_sphinx.txt b/ci/conda_env_sphinx.txt
index 751df9b2f3..840577fdd9 100644
--- a/ci/conda_env_sphinx.txt
+++ b/ci/conda_env_sphinx.txt
@@ -20,6 +20,9 @@ breathe
doxygen
ipython
linkify-it-py
+# We can't install linuxdoc by conda. We install linuxdoc by pip in
+# ci/dockerfiles/conda-python-pandas.dockerfile.
+# linuxdoc
myst-parser
numpydoc
pydata-sphinx-theme=0.14
diff --git a/ci/docker/conda-python-pandas.dockerfile
b/ci/docker/conda-python-pandas.dockerfile
index 9ee62cd282..4a52ffa8e1 100644
--- a/ci/docker/conda-python-pandas.dockerfile
+++ b/ci/docker/conda-python-pandas.dockerfile
@@ -27,6 +27,8 @@ ARG numpy=latest
# so ensure to install doc requirements
COPY ci/conda_env_sphinx.txt /arrow/ci/
RUN mamba install -q -y --file arrow/ci/conda_env_sphinx.txt && \
+ # We can't install linuxdoc by mamba. We install linuxdoc by pip here.
+ pip install linuxdoc && \
mamba clean --all
COPY ci/scripts/install_pandas.sh /arrow/ci/scripts/
diff --git a/docs/requirements.txt b/docs/requirements.txt
index afb252e174..493528fb5c 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -4,6 +4,7 @@
breathe
ipython
+linuxdoc
myst-parser[linkify]
numpydoc
pydata-sphinx-theme~=0.14
diff --git a/docs/source/conf.py b/docs/source/conf.py
index e9b926e884..b2d3245e4a 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -114,6 +114,7 @@ extensions = [
'breathe',
'IPython.sphinxext.ipython_console_highlighting',
'IPython.sphinxext.ipython_directive',
+ 'linuxdoc.rstFlatTable',
'myst_parser',
'numpydoc',
'sphinx_design',
diff --git a/docs/source/format/StatisticsSchema.rst
b/docs/source/format/StatisticsSchema.rst
index 01cc0da7c4..0e0752ff56 100644
--- a/docs/source/format/StatisticsSchema.rst
+++ b/docs/source/format/StatisticsSchema.rst
@@ -253,7 +253,7 @@ Data::
Statistics:
-.. list-table::
+.. flat-table::
:header-rows: 1
* - Target
@@ -262,29 +262,23 @@ Statistics:
* - Record batch
- The number of rows
- ``5``
- * - ``vendor_id``
+ * - :rspan:`3` ``vendor_id``
- The number of nulls
- ``0``
- * - ``vendor_id``
- - The number of distinct values
+ * - The number of distinct values
- ``2``
- * - ``vendor_id``
- - The max value
+ * - The max value
- ``5``
- * - ``vendor_id``
- - The min value
+ * - The min value
- ``1``
- * - ``passenger_count``
+ * - :rspan:`4` ``passenger_count``
- The number of nulls
- ``1``
- * - ``passenger_count``
- - The number of distinct values
+ * - The number of distinct values
- ``3``
- * - ``passenger_count``
- - The max value
+ * - The max value
- ``2``
- * - ``passenger_count``
- - The min value
+ * - The min value
- ``0``
Column indexes:
@@ -314,15 +308,15 @@ Statistics array::
column: [
null, # record batch
0, # vendor_id
- 0, # vendor_id
- 0, # vendor_id
- 0, # vendor_id
- 1, # passenger_count
- 1, # passenger_count
- 1, # passenger_count
1, # passenger_count
]
statistics:
+ offsets: [
+ 0,
+ 1, # record batch: 1 value: [0]
+ 5, # vendor_id: 4 values: [1, 2, 3, 4]
+ 9, # passenger_count: 4 values: [5, 6, 7, 8]
+ ]
key:
values: [
"ARROW:row_count:exact",
@@ -330,7 +324,7 @@ Statistics array::
"ARROW:distinct_count:exact",
"ARROW:max_value:exact",
"ARROW:min_value:exact",
- ],
+ ]
indices: [
0, # "ARROW:row_count:exact"
1, # "ARROW:null_count:exact"
@@ -399,7 +393,7 @@ Data::
Statistics:
-.. list-table::
+.. flat-table::
:header-rows: 1
* - Target
@@ -411,41 +405,34 @@ Statistics:
* - ``col1``
- The number of nulls
- ``0``
- * - ``col1.a``
+ * - :rspan:`3` ``col1.a``
- The number of nulls
- ``0``
- * - ``col1.a``
- - The number of distinct values
+ * - The number of distinct values
- ``3``
- * - ``col1.a``
- - The approximate max value
+ * - The approximate max value
- ``5``
- * - ``col1.a``
- - The approximate min value
+ * - The approximate min value
- ``0``
* - ``col1.b``
- The number of nulls
- ``1``
- * - ``col1.b.item``
+ * - :rspan:`1` ``col1.b.item``
- The max value
- ``99``
- * - ``col1.b.item``
- - The min value
+ * - The min value
- ``20``
- * - ``col1.c``
+ * - :rspan:`2` ``col1.c``
- The number of nulls
- ``1``
- * - ``col1.c``
- - The approximate max value
+ * - The approximate max value
- ``3.0``
- * - ``col1.c``
- - The approximate min value
+ * - The approximate min value
- ``-3.0``
- * - ``col2``
+ * - :rspan:`1` ``col2``
- The number of nulls
- ``1``
- * - ``col2``
- - The number of distinct values
+ * - The number of distinct values
- ``2``
Column indexes:
@@ -491,19 +478,22 @@ Statistics array::
null, # record batch
0, # col1
1, # col1.a
- 1, # col1.a
- 1, # col1.a
- 1, # col1.a
2, # col1.b
3, # col1.b.item
- 3, # col1.b.item
- 4, # col1.c
- 4, # col1.c
4, # col1.c
5, # col2
- 5, # col2
]
statistics:
+ offsets: [
+ 0,
+ 1, # record batch: 1 value: [0]
+ 2, # col1: 1 value: [1]
+ 6, # col1.a: 4 values: [2, 3, 4, 5]
+ 7, # col1.b: 1 value: [6]
+ 9, # col1.b.item: 2 values: [7, 8]
+ 12, # col1.c: 3 values: [9, 10, 11]
+ 14, # col2: 2 values: [12, 13]
+ ]
key:
values: [
"ARROW:row_count:exact",
@@ -596,26 +586,22 @@ Data::
Statistics:
-.. list-table::
+.. flat-table::
:header-rows: 1
* - Target
- Name
- Value
- * - Array
+ * - :rspan:`4` Array
- The number of rows
- ``5``
- * - Array
- - The number of nulls
+ * - The number of nulls
- ``1``
- * - Array
- - The number of distinct values
+ * - The number of distinct values
- ``3``
- * - Array
- - The max value
+ * - The max value
- ``2``
- * - Array
- - The min value
+ * - The min value
- ``0``
Column indexes:
@@ -642,12 +628,12 @@ Statistics array::
column: [
0, # array
- 0, # array
- 0, # array
- 0, # array
- 0, # array
]
statistics:
+ offsets: [
+ 0,
+ 5, # array: 5 values: [0, 1, 2, 3, 4]
+ ]
key:
values: [
"ARROW:row_count:exact",
@@ -706,47 +692,40 @@ Data::
Statistics:
-.. list-table::
+.. flat-table::
:header-rows: 1
* - Target
- Name
- Value
- * - Array
+ * - :rspan:`1` Array
- The number of rows
- ``3``
- * - Array
- - The number of nulls
+ * - The number of nulls
- ``0``
- * - ``a``
+ * - :rspan:`3` ``a``
- The number of nulls
- ``0``
- * - ``a``
- - The number of distinct values
+ * - The number of distinct values
- ``3``
- * - ``a``
- - The approximate max value
+ * - The approximate max value
- ``5``
- * - ``a``
- - The approximate min value
+ * - The approximate min value
- ``0``
* - ``b``
- The number of nulls
- ``1``
- * - ``b.item``
+ * - :rspan:`1` ``b.item``
- The max value
- ``99``
- * - ``b.item``
- - The min value
+ * - The min value
- ``20``
- * - ``c``
+ * - :rspan:`2` ``c``
- The number of nulls
- ``1``
- * - ``c``
- - The approximate max value
+ * - The approximate max value
- ``3.0``
- * - ``c``
- - The approximate min value
+ * - The approximate min value
- ``-3.0``
Column indexes:
@@ -788,19 +767,20 @@ Statistics array::
column: [
0, # array
- 0, # array
- 1, # a
- 1, # a
- 1, # a
1, # a
2, # b
3, # b.item
- 3, # b.item
- 4, # c
- 4, # c
4, # c
]
statistics:
+ offsets: [
+ 0,
+ 2, # array: 2 values: [0, 1]
+ 6, # a: 4 values: [2, 3, 4, 5]
+ 7, # b: 1 value: [6]
+ 9, # b.item: 2 values: [7, 8]
+ 12, # c: 3 values: [9, 10, 11]
+ ]
key:
values: [
"ARROW:row_count:exact",
