DOC: Remove absolute urls from the docs #32539

ArkadeepAdhikari · 2020-03-08T05:37:10Z

closes DOC: Remove absolute urls from the docs #32529
tests added / passed
passes black pandas
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

jorisvandenbossche · 2020-03-08T20:31:11Z

pandas/core/generic.py

-        To learn more about the frequency strings, please see `this link
-        <https://pandas.pydata.org/pandas-docs/stable/user_guide/timeseries.html#offset-aliases>`__.
+        To learn more about the frequency strings, please see this link:
+        :ref:`Timeseries <timeseries.offset_aliases>`


This one should be kept as is (or with updated url if needed), as the docstrings are otherwise not useful as plain text

(and the same for the other changes below in .py files)

Ok, Reverting these changes

ArkadeepAdhikari · 2020-03-09T06:27:21Z

Hi @jorisvandenbossche , I have updated my PR, it would be great if you can review once again. Thanks.

jorisvandenbossche

Some more cases where we need to keep the absolute url .. (in practice, it seems that mostly there were good reasons we were doing that)

jorisvandenbossche · 2020-03-09T19:10:19Z

doc/source/getting_started/comparison/comparison_with_sql.rst


 DataFrames can be filtered in multiple ways; the most intuitive of which is using
-`boolean indexing <https://pandas.pydata.org/pandas-docs/stable/indexing.html#boolean-indexing>`_.
+:ref:`Boolean indexing <indexing.boolean>`


Suggested change

:ref:`Boolean indexing <indexing.boolean>`

:ref:`boolean indexing <indexing.boolean>`

jorisvandenbossche · 2020-03-09T19:11:52Z

doc/source/user_guide/indexing.rst


    In [1]: df = pd.DataFrame({'one': [1., 2., 3.]})
    In [2]: df.two = [4, 5, 6]
-    UserWarning: Pandas doesn't allow Series to be assigned into nonexistent columns - see https://pandas.pydata.org/pandas-docs/stable/indexing.html#attribute_access


Can you revert this one as well? (it's in the output of code, which should still return the absolute url)

jorisvandenbossche · 2020-03-09T19:12:42Z

doc/source/user_guide/indexing.rst


   See the documentation here:
-   https://pandas.pydata.org/pandas-docs/stable/indexing.html#deprecate-loc-reindex-listlike
+   :ref:`Deprecation doc <indexing.deprecate_loc_reindex_listlike>`


You can make the "here" the text of the reference (and remove the colon), I think.

jorisvandenbossche · 2020-03-09T19:12:48Z

doc/source/whatsnew/v0.21.0.rst

   KeyError in the future, you can use .reindex() as an alternative.

   See the documentation here:
-   https://pandas.pydata.org/pandas-docs/stable/indexing.html#deprecate-loc-reindex-listlike


This is also code output that should be left alone

jorisvandenbossche · 2020-03-09T19:14:10Z

doc/source/whatsnew/v0.23.0.rst


   Starting January 1, 2019, pandas feature releases will support Python 3 only.
-   See `Dropping Python 2.7 <https://pandas.pydata.org/pandas-docs/version/0.24/install.html#install-dropping-27>`_ for more.
+   See :ref:`Dropping Python 2.7 <install>` for more.


You will need to keep the absolute reference here as well, since this needs to refer to the versioned docs (that page doesn't exist anymore on the stable docs)

jorisvandenbossche · 2020-03-09T19:14:21Z

doc/source/whatsnew/v0.23.1.rst


   Starting January 1, 2019, pandas feature releases will support Python 3 only.
-   See `Dropping Python 2.7 <https://pandas.pydata.org/pandas-docs/version/0.24/install.html#install-dropping-27>`_ for more.
+   See :ref:`Dropping Python 2.7 <install>` for more.


jorisvandenbossche · 2020-03-09T19:14:27Z

doc/source/whatsnew/v0.23.2.rst


   Starting January 1, 2019, pandas feature releases will support Python 3 only.
-   See `Dropping Python 2.7 <https://pandas.pydata.org/pandas-docs/version/0.24/install.html#install-dropping-27>`_ for more.
+   See :ref:`Dropping Python 2.7 <install>` for more.


jorisvandenbossche · 2020-03-09T19:14:34Z

doc/source/whatsnew/v0.23.4.rst


   Starting January 1, 2019, pandas feature releases will support Python 3 only.
-   See `Dropping Python 2.7 <https://pandas.pydata.org/pandas-docs/version/0.24/install.html#install-dropping-27>`_ for more.
+   See :ref:`Dropping Python 2.7 <install>` for more.


same here (and others below)

ArkadeepAdhikari · 2020-03-10T01:10:56Z

Hi @jorisvandenbossche , I have made the changes, it would be great if you can look into once again. Thanks.

jorisvandenbossche

One last remaining comment!

jorisvandenbossche · 2020-03-10T07:08:53Z

doc/source/whatsnew/v0.21.0.rst

   KeyError in the future, you can use .reindex() as an alternative.

   See the documentation here:
-   https://pandas.pydata.org/pandas-docs/stable/indexing.html#deprecate-loc-reindex-listlike


This is also code output that should be left alone

datapythonista · 2020-03-10T22:09:18Z

Sorry for the poor issue description from my side @ArkadeepAdhikari. Looks good, there is just one case that needs to be reverted.

Also, if you can add to ci/code_checks.sh a check to make sure the pattern pandas.pydata.org doesn't exist in doc/source anymore that would be very useful.

ArkadeepAdhikari · 2020-03-10T22:48:02Z

Hi @datapythonista, should I be adding the check to not keep pandas.pydata.org in doc/source? Some of the files like the one I would be reverting are in the same path (for example: doc/source/whatsnew/v0.21.0.rst)

datapythonista · 2020-03-10T23:09:44Z

Good point. Let's leave it for later, as we'll need to think whether it's worth validating it and how.

jorisvandenbossche · 2020-03-10T23:11:29Z

Also, if you can add to ci/code_checks.sh a check to make sure the pattern pandas.pydata.org doesn't exist in doc/source anymore that would be very useful.

Since there are actually cases where we have this url in doc/source (several ones we reverted here in the PR), and given that there were not that much occurences to fix, I personally don't think it is worth the effort to make a code check for this

ArkadeepAdhikari · 2020-03-11T00:05:22Z

Hi @datapythonista, @jorisvandenbossche, thanks for the clarifications. I have reverted the final case. Please take a look again. Thanks.

datapythonista · 2020-03-11T00:19:10Z

doc/source/user_guide/indexing.rst


-   See the documentation here:
-   https://pandas.pydata.org/pandas-docs/stable/indexing.html#deprecate-loc-reindex-listlike
+   See the documentation :ref:`here <indexing.deprecate_loc_reindex_listlike>`


I think this is also an output from pandas, not an actual link that we want to change, isn't it?

Yes this looks like a similar case, @jorisvandenbossche can you confirm?

ArkadeepAdhikari · 2020-03-12T02:23:41Z

Hi @datapythonista, I have updated my PR, please feel free to review once again.

jorisvandenbossche · 2020-03-12T07:15:38Z

Thanks @ArkadeepAdhikari !

ArkadeepAdhikari · 2020-03-12T08:03:38Z

Thanks for reviewing @jorisvandenbossche, @datapythonista!

ArkadeepAdhikari added 10 commits March 7, 2020 21:24

Initial commit

d0a3171

minor change

7bd7acd

minor changes

5f5bba8

Adding some more files

f4af3bd

Adding some more files

1110e71

minor changes

942986d

Updating cookbook timeseries alias

e55cf6a

changes to cookbook

61731e3

cookbook changes

41509b5

Updating timeseries offset links

adbc35b

jorisvandenbossche requested changes Mar 8, 2020

View reviewed changes

PR comments updates

e168fff

ArkadeepAdhikari force-pushed the remove_abs_url branch 2 times, most recently from 28066af to addffc1 Compare March 8, 2020 23:15

adding whatsnew docs

a6b9927

ArkadeepAdhikari force-pushed the remove_abs_url branch from addffc1 to a6b9927 Compare March 8, 2020 23:44

ArkadeepAdhikari added 6 commits March 8, 2020 17:26

updating whatsnew docs

77171e1

updating whatsnew docs

1fd0987

updating whatsnew docs

63a67e5

adding whatsnew docs

c61c4b0

updating whatsnew docs

a90c640

updating whatsnew docs

5239174

ArkadeepAdhikari force-pushed the remove_abs_url branch from fbdd732 to 5239174 Compare March 9, 2020 04:32

ArkadeepAdhikari added 2 commits March 8, 2020 22:03

updating comparison with sql doc

2e6d4c6

updating indexing docs

3f18268

ArkadeepAdhikari marked this pull request as ready for review March 9, 2020 06:27

jorisvandenbossche reviewed Mar 9, 2020

View reviewed changes

ArkadeepAdhikari added 2 commits March 9, 2020 15:08

PR comments

4833835

PR comments

f1d3e2e

jorisvandenbossche reviewed Mar 10, 2020

View reviewed changes

datapythonista added Clean Docs labels Mar 10, 2020

PR comments

68bed39

datapythonista reviewed Mar 11, 2020

View reviewed changes

jreback added this to the 1.1 milestone Mar 11, 2020

PR comments

fc03dfe

jorisvandenbossche approved these changes Mar 12, 2020

View reviewed changes

jorisvandenbossche merged commit ec77341 into pandas-dev:master Mar 12, 2020

SeeminSyed pushed a commit to CSCD01-team01/pandas that referenced this pull request Mar 22, 2020

DOC: Remove absolute urls from the docs (pandas-dev#32539)

0ea5744

	:ref:`Boolean indexing <indexing.boolean>`
	:ref:`boolean indexing <indexing.boolean>`

Uh oh!

DOC: Remove absolute urls from the docs #32539

DOC: Remove absolute urls from the docs #32539

Uh oh!

Conversation

ArkadeepAdhikari commented Mar 8, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ArkadeepAdhikari commented Mar 9, 2020

Uh oh!

jorisvandenbossche left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ArkadeepAdhikari commented Mar 10, 2020

Uh oh!

jorisvandenbossche left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

datapythonista commented Mar 10, 2020

Uh oh!

ArkadeepAdhikari commented Mar 10, 2020

Uh oh!

datapythonista commented Mar 10, 2020

Uh oh!

jorisvandenbossche commented Mar 10, 2020

Uh oh!

ArkadeepAdhikari commented Mar 11, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ArkadeepAdhikari commented Mar 12, 2020

Uh oh!

jorisvandenbossche commented Mar 12, 2020

Uh oh!

ArkadeepAdhikari commented Mar 12, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

ArkadeepAdhikari commented Mar 8, 2020 •

edited

Loading