Skip to content

DOC: Incorrect link in StringArray and ArrowStringArray docs #50230

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

Closed
1 task done
ivirshup opened this issue Dec 13, 2022 · 1 comment · Fixed by #50241
Closed
1 task done

DOC: Incorrect link in StringArray and ArrowStringArray docs #50230

ivirshup opened this issue Dec 13, 2022 · 1 comment · Fixed by #50241

Comments

@ivirshup
Copy link
Contributor

Pandas version checks

  • I have checked that the issue still exists on the latest versions of the docs on main here

Location of the documentation

https://pandas.pydata.org/docs/dev/reference/api/pandas.arrays.StringArray.html

https://pandas.pydata.org/docs/dev/reference/api/pandas.arrays.ArrowStringArray.html

Documentation problem

image

This says it links to the pandas.array function, when it actually links to the python array module

image

image

Suggested fix for documentation

It should link to pandas.array, but I'm not completley sure what sphinx wants here. Maybe using a fully qualified identifier?

@ivirshup ivirshup added Docs Needs Triage Issue that has not been reviewed by a pandas team member labels Dec 13, 2022
@MarcoGorelli MarcoGorelli added good first issue and removed Needs Triage Issue that has not been reviewed by a pandas team member labels Dec 13, 2022
@MarcoGorelli
Copy link
Member

thanks for the report

here's the code

See Also
--------
array
The recommended function for creating a ArrowStringArray.
Series.str
The string methods are available on Series backed by
a ArrowStringArray.

if anyone wants to have a go at fixing the link

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.

2 participants