Skip to content
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.

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

bpo-36797: Prune more legacy distutils documentation #13092

Merged

Conversation

ncoghlan
Copy link
Contributor

@ncoghlan ncoghlan commented May 4, 2019

@ncoghlan ncoghlan requested a review from jaraco May 4, 2019 22:22
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting core review labels May 4, 2019
@ncoghlan
Copy link
Contributor Author

ncoghlan commented May 4, 2019

@pganssle Reviewing @kojoidrissa's change in #13087 prompted me to make the markings on the rest of the legacy distutils docs a bit more emphatic in saying "This probably isn't the page you want to be looking at"

@pganssle
Copy link
Member

pganssle commented May 4, 2019

Hm, would it be worth it to move the .. note into a separate stub and use .. include:: instead of copy-pasting it everywhere?

Given that there's a URL in it, it might be worth it to have a canonical stub for this.

@ncoghlan
Copy link
Contributor Author

ncoghlan commented May 4, 2019

@pganssle Yeah, that would make a lot of sense.

Copy link
Contributor

@eamanu eamanu left a comment

Choose a reason for hiding this comment

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

LGTM

@ncoghlan ncoghlan merged commit dae1229 into python:master May 14, 2019
@@ -4,6 +4,16 @@
API Reference
*************

.. seealso::

`New and changed setup.py arguments in setuptools <setuptools-setup-py>`_
Copy link
Contributor

Choose a reason for hiding this comment

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

@ncoghlan This is a dead link to https://docs.python.org/3.8/distutils/setuptools-setup-py

See linkchecker output:


URL        `setuptools-setup-py'
Name       `New and changed setup.py arguments in setuptools'
Parent URL file:///builddir/build/BUILD/Python-3.8.0b4/Doc/build/html/distutils/apiref.html, line 106, col 5
Real URL   file:///builddir/build/BUILD/Python-3.8.0b4/Doc/build/html/distutils/setuptools-setup-py
Check time 0.001 seconds
Result     Error: URLError: <urlopen error [Errno 2] No such file or directory: '/builddir/build/BUILD/Python-3.8.0b4/Doc/build/html/distutils/setuptools-setup-py'>
 4 threads active,     0 links queued, 4445 links in 4449 URLs checked, runtime 1 minute, 46 seconds

Where is this actually supposed to lead to?

and other APIs, makes the API consistent across different Python versions,
and is hence recommended over using ``distutils`` directly.

.. _setuptools-setup-py: https://setuptools.readthedocs.io/en/latest/setuptools.html#new-and-changed-setup-keywords
Copy link
Contributor

Choose a reason for hiding this comment

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

Oh I see, this should be the link. I'll prep a PR.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants