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

[Python][Docs] Documentation pages for PyArrow have incorrect hyperlinks #30781

Closed
asfimport opened this issue Jan 10, 2022 · 5 comments
Closed

Comments

@asfimport
Copy link

API documentation for pyarrow has a few confusing "mis"links. As an example, on the page below, the link for "csv.ReadOptions" actually takes me to "json.ReadOptions."

I'm filing a bug because the pages were similar enough that I initially just assumed the csv parsing had limited functionality instead of realizing I was looking in the wrong place. 

Example page:
https://arrow.apache.org/docs/python/generated/pyarrow.dataset.CsvFileFormat.html

where ReadOptions and ParseOptions incorrectly link me to the JSON versions instead of CSV versions. ConvertOptions is correct, though.

I have no idea how widespread this issue is as I have only looked and noticed the issue on this one page linked above.

Reporter: Joshua Robinson
Assignee: Alessandro Molina / @amol-

Note: This issue was originally created as ARROW-15290. Please see the migration documentation for further details.

@asfimport
Copy link
Author

David Li / @lidavidm:
I think for these specific cases, they will be fixed for 7.0.0. See the development branch where they now explicitly reference the csv module:

cdef class CsvFileFormat(FileFormat):
"""
FileFormat for CSV files.
Parameters
----------
parse_options : csv.ParseOptions
Options regarding CSV parsing.
convert_options : csv.ConvertOptions
Options regarding value conversion.
read_options : csv.ReadOptions
General read options.
default_fragment_scan_options : CsvFragmentScanOptions
Default options for fragments scan.
"""

@asfimport
Copy link
Author

David Li / @lidavidm:
If you do see anything else like this though, please feel free to report here or file a new issue and we'll try to take care of it. Thanks!

(You can also file a PR on GitHub - no need to create a Jira for small documentation things.)

@asfimport
Copy link
Author

Joshua Robinson:
thanks for the quick response!

@asfimport
Copy link
Author

Alessandro Molina / @amol-:
I'll track this one to ensure that the changes we did actually fix the linking problem.

@asfimport
Copy link
Author

Krisztian Szucs / @kszucs:
Closing as resolved since the links are correct in the nightly development docs https://arrow.apache.org/docs/dev/python/generated/pyarrow.dataset.CsvFileFormat.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants