Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] DoubleArray and FloatingPointArray are missing from generated Python docs #35413

Closed
spenczar opened this issue May 3, 2023 · 2 comments · Fixed by #35414
Closed

[Docs] DoubleArray and FloatingPointArray are missing from generated Python docs #35413

spenczar opened this issue May 3, 2023 · 2 comments · Fixed by #35414

Comments

@spenczar
Copy link
Contributor

spenczar commented May 3, 2023

Describe the bug, including details regarding any error messages, version, and platform.

https://arrow.apache.org/docs/python/api/arrays.html lists the concrete array types available in Pyarrow. But some are missing:

arrow/python/pyarrow/array.pxi

Lines 1870 to 1885 in 205ceb9

cdef class HalfFloatArray(FloatingPointArray):
"""
Concrete class for Arrow arrays of float16 data type.
"""
cdef class FloatArray(FloatingPointArray):
"""
Concrete class for Arrow arrays of float32 data type.
"""
cdef class DoubleArray(FloatingPointArray):
"""
Concrete class for Arrow arrays of float64 data type.
"""
lists the float16/float32/float64 concrete array types, and they don't appear in the generated table, nor do their direct links (eg https://arrow.apache.org/docs/python/generated/pyarrow.DoubleArray.html) work.

Component(s)

Documentation, Python

@spenczar
Copy link
Contributor Author

spenczar commented May 3, 2023

It appears to me that this is because those types are not in the big list of exported types in https://github.com/apache/arrow/blob/205ceb99389d2d5060551ebcba17635185c74d9d/python/pyarrow/__init__.py#L200C1-L202. Is that an oversight, or intentional?

@AlenkaF
Copy link
Member

AlenkaF commented May 8, 2023

Thank you for reporting! I think this is not intentional.
In the PR you could add a comment to generate the preview of the docs: @github-actions crossbow submit preview-docs.

jorisvandenbossche pushed a commit that referenced this issue May 24, 2023
… public API (#35414)

### Rationale for this change

These concrete types appear to have been overlooked.

### What changes are included in this PR?

n/a

### Are these changes tested?

n/a

### Are there any user-facing changes?

Yes - I didn't rebuild docs, do I need to do that?
* Closes: #35413

Authored-by: Spencer Nelson <spencer@b612foundation.org>
Signed-off-by: Joris Van den Bossche <jorisvandenbossche@gmail.com>
@jorisvandenbossche jorisvandenbossche added this to the 13.0.0 milestone May 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants