Skip to content

DOC: added the link to array in string_arrow.py #50241

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.

Sign up for GitHub

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

Merged
merged 8 commits into from
Dec 19, 2022
Merged

DOC: added the link to array in string_arrow.py #50241

Changes from 5 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
74d11c1
added the link to array in string_arrow.py
ramvikrams Dec 13, 2022
7af1b03
Merge branch 'main' into t001
ramvikrams Dec 13, 2022
d8e5408
Update string_arrow.py
ramvikrams Dec 14, 2022
7d4f543
Merge branch 't001' of https://github.com/ramvikrams/pandas into t001
ramvikrams Dec 14, 2022
f666583
Update string_arrow.py
ramvikrams Dec 14, 2022
5a8d1ec
added the correct link to pandas.array
ramvikrams Dec 16, 2022
151a9ae
update
ramvikrams Dec 17, 2022
33ad03e
Merge branch 'main' into t001
ramvikrams Dec 17, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion pandas/core/arrays/string_arrow.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,8 @@ class ArrowStringArray(ArrowExtensionArray, BaseStringArray, ObjectStringArrayMi

See Also
--------
array
`array
<https://pandas.pydata.org/docs/dev/reference/api/pandas.arrays.ArrowStringArray.html>`__
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only one underscore? Not sure but doc build is failing

Copy link
Contributor Author

@ramvikrams ramvikrams Dec 14, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are two underscores, this was on the sphinx site to have two underscores and the doc build fails if we have just one inderscore

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @ramvikrams! I think the intent here is for this to point to pandas.array instead of ArrowStringArray. Something like the suggestion below should handle that. It also will make it so the link always points to the version of the documentation page that's currently being used. As is, the link in this PR will point to the dev version of the docs.

Suggested change
`array
<https://pandas.pydata.org/docs/dev/reference/api/pandas.arrays.ArrowStringArray.html>`__
pandas.array

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes i'll do that

The recommended function for creating a ArrowStringArray.
Series.str
The string methods are available on Series backed by
Expand Down