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

Show file tree
Hide file tree
Changes from 6 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_.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,8 @@ class StringArray(BaseStringArray, PandasArray):

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

Choose a reason for hiding this comment

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

Could you make this link without using a hyperlink i.e. the correct reference that sphinx will pick up?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I had a question I don't know about this way could you tell some doc where I can read about it

Copy link
Member

Choose a reason for hiding this comment

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

Maybe https://stackoverflow.com/questions/40980041/link-to-see-also-functions-in-sphinx-docstrings and related searches?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks I'll check it out

Copy link
Member

Choose a reason for hiding this comment

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

Thanks could you render the docs to validate how this looks?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks could you render the docs to validate how this looks?

looks and works fine

Copy link
Member

Choose a reason for hiding this comment

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

Could you post a screenshot of the rendered docs?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Could you post a screenshot of the rendered docs?

yes

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Screenshot from 2022-12-20 02-43-03
Screenshot from 2022-12-20 02-43-11
Screenshot from 2022-12-20 02-43-19
Screenshot from 2022-12-20 02-43-43

Copy link
Contributor Author

@ramvikrams ramvikrams Dec 19, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

added the screenshot sorry it took time I was struggling on how to add screenshot and at last saw that we can attach files by dragging, I have also attached the screenshot of array page opening nicely when clicking array in the doc for ArrowStringArray and StringArray

The recommended function for creating a StringArray.
Series.str
The string methods are available on Series backed by
Expand Down
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/reference/api/pandas.array.html>`__
The recommended function for creating a ArrowStringArray.
Series.str
The string methods are available on Series backed by
Expand Down