DOC: Fixed redirects in various parts of the documentation #26497
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Links in the docs to part way down a page were being sent to the top of the page due to a generic redirect from pandas.pydata.org/pandas-doc/stable > pandas.pydata.org/pandas-doc/stable/user_guide. These links have been change to go straight to the .../user_guide/... version of the page to ensure the link goes to the correct part of the docs.
Codecov Report
@@ Coverage Diff @@
## master #26497 +/- ##
==========================================
- Coverage 91.75% 91.74% -0.01%
==========================================
Files 174 174
Lines 50761 50761
==========================================
- Hits 46575 46570 -5
- Misses 4186 4191 +5
Continue to review full report at Codecov.
|
1 similar comment
Codecov Report
@@ Coverage Diff @@
## master #26497 +/- ##
==========================================
- Coverage 91.75% 91.74% -0.01%
==========================================
Files 174 174
Lines 50761 50761
==========================================
- Hits 46575 46570 -5
- Misses 4186 4191 +5
Continue to review full report at Codecov.
|
| @@ -272,7 +272,8 @@ class Categorical(ExtensionArray, PandasObject): | |||
| Notes | |||
| ----- | |||
| See the `user guide | |||
| <http://pandas.pydata.org/pandas-docs/stable/categorical.html>`_ for more. | |||
| <http://pandas.pydata.org/pandas-docs/stable/user_guide/categorical.html>`_ | |||
There was a problem hiding this comment.
Can we use refs for these instead instead? I think this would be, e.g. :ref:`categorical`.
There was a problem hiding this comment.
I like the explicit urls in the doc strings: If in doubt after reading a doc string, I can just copy/paste the url into a browser....couldn't do that with a ref.
There was a problem hiding this comment.
It looks like both are used in various parts of the documentation, although :ref: does seem a bit more common now that I look. Is there an agreed best practice?
|
I prefer the :ref: syntax, as it will be updated if the section title
changes. Though it does have the the downside mentioned
by @topper-123 when viewing the raw docstring.
…On Thu, May 23, 2019 at 3:04 PM lrjball ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In pandas/core/arrays/categorical.py
<#26497 (comment)>:
> @@ -272,7 +272,8 @@ class Categorical(ExtensionArray, PandasObject):
Notes
-----
See the `user guide
- <http://pandas.pydata.org/pandas-docs/stable/categorical.html>`_ for more.
+ <http://pandas.pydata.org/pandas-docs/stable/user_guide/categorical.html>`_
It looks like both are used in various parts of the documentation,
although :ref: does seem a bit more common now that I look. Is there an
agreed best practice?
—
You are receiving this because you commented.
Reply to this email directly, view it on GitHub
<#26497?email_source=notifications&email_token=AAKAOITDXZKISWMDURTSWKLPW32GJA5CNFSM4HOX6KM2YY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOBZR5DPI#discussion_r287112750>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAKAOIQHIDHP6KBW7MLDKOLPW32GJANCNFSM4HOX6KMQ>
.
|
|
This pull request is to fix the links which were going to the wrong place. It seems like whether :ref: or urls are used is a separate issue, as urls are used all over the documentation, not just in the places I have fixed here. Maybe replacing urls with :ref: could be raised as it's own issue. |
WillAyd
approved these changes
May 30, 2019
|
Sure.
…On Thu, May 30, 2019 at 10:25 AM William Ayd ***@***.***> wrote:
***@***.**** approved this pull request.
I'm OK with this as is and follow up PR to convert to ref.
@TomAugspurger <https://github.com/TomAugspurger>
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#26497?email_source=notifications&email_token=AAKAOIQHJA44L3CRYNW7LI3PX7WVJA5CNFSM4HOX6KM2YY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOB2EQFFY#pullrequestreview-243860119>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAKAOIX2IJZHN7UJWA7BECLPX7WVJANCNFSM4HOX6KMQ>
.
|
|
Thanks @lrjball ! |
|
Cheers |
|
I don't think anyone is working on that.
…On Mon, Jun 3, 2019 at 1:27 PM lrjball ***@***.***> wrote:
Cheers
@TomAugspurger <https://github.com/TomAugspurger> I'm happy to pick up a
PR to change all links to refs unless you have already picked it up.
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#26497?email_source=notifications&email_token=AAKAOISIJNCALG2RRTW52J3PYVPAZA5CNFSM4HOX6KM2YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGODW2I3DA#issuecomment-498371980>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAKAOISBYVTANL5C2HPGN43PYVPAZANCNFSM4HOX6KMQ>
.
|
vaibhavhrt
pushed a commit
to vaibhavhrt/pandas
that referenced
this pull request
Jun 6, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Links in the docs to part way down a page were being sent to the top of the page due to a generic redirect from pandas.pydata.org/pandas-doc/stable/... -> pandas.pydata.org/pandas-doc/stable/user_guide/... . These links have been change to go straight to the .../user_guide/... version of the page to ensure the link goes to the correct part of the docs.
For example, the link within the
chunksizeparameter of pandas.read_json() currently goes to the top of the IO Tools page, when the relevant section is the 'Line delimited json' heading about half way down.