DOC: added the link to array in string_arrow.py #50241
Conversation
pandas/core/arrays/string_arrow.py
Outdated
| @@ -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>`__ | |||
There was a problem hiding this comment.
Only one underscore? Not sure but doc build is failing
There was a problem hiding this comment.
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
pandas/core/arrays/string_arrow.py
Outdated
| `array | ||
| <https://pandas.pydata.org/docs/dev/reference/api/pandas.arrays.ArrowStringArray.html>`__ |
There was a problem hiding this comment.
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.
| `array | |
| <https://pandas.pydata.org/docs/dev/reference/api/pandas.arrays.ArrowStringArray.html>`__ | |
| pandas.array |
There was a problem hiding this comment.
Yes i'll do that
pandas/core/arrays/string_.py
Outdated
| @@ -266,7 +266,8 @@ class StringArray(BaseStringArray, PandasArray): | |||
|
|
|||
| See Also | |||
| -------- | |||
| array | |||
| `array | |||
| <https://pandas.pydata.org/docs/reference/api/pandas.array.html>`__ | |||
There was a problem hiding this comment.
Could you make this link without using a hyperlink i.e. the correct reference that sphinx will pick up?
There was a problem hiding this comment.
I had a question I don't know about this way could you tell some doc where I can read about it
There was a problem hiding this comment.
Maybe https://stackoverflow.com/questions/40980041/link-to-see-also-functions-in-sphinx-docstrings and related searches?
There was a problem hiding this comment.
Thanks I'll check it out
There was a problem hiding this comment.
Thanks could you render the docs to validate how this looks?
There was a problem hiding this comment.
Thanks could you render the docs to validate how this looks?
looks and works fine
There was a problem hiding this comment.
Could you post a screenshot of the rendered docs?
There was a problem hiding this comment.
Could you post a screenshot of the rendered docs?
yes
There was a problem hiding this comment.
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
|
Thanks @ramvikrams |
thanks |
doc/source/whatsnew/vX.X.X.rstfile if fixing a bug or adding a new feature.