Uploaded image for project: 'Apache Arrow'
  1. Apache Arrow
  2. ARROW-15290

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

Log workAgile BoardRank to TopRank to BottomAttach filesAttach ScreenshotBulk Copy AttachmentsBulk Move AttachmentsVotersWatch issueWatchersCreate sub-taskConvert to sub-taskLinkCloneLabelsUpdate Comment AuthorReplace String in CommentUpdate Comment VisibilityDelete Comments
    XMLWordPrintableJSON

Details

    • Bug
    • Status: Resolved
    • Minor
    • Resolution: Fixed
    • None
    • 7.0.0
    • Documentation, Python
    • None

    Description

      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.

      Attachments

        Activity

          This comment will be Viewable by All Users Viewable by All Users
          Cancel

          People

            amol- Alessandro Molina Assign to me
            joshuarobinson Joshua Robinson
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Slack

                Issue deployment