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.

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

Jump to bottom

Some expired hyperlinks in Python documentation #88727

Closed
StevenHsuYL mannequin opened this issue Jul 4, 2021 · 9 comments
Closed

Some expired hyperlinks in Python documentation #88727

StevenHsuYL mannequin opened this issue Jul 4, 2021 · 9 comments
Labels
3.9 only security fixes 3.10 only security fixes 3.11 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement

Comments

@StevenHsuYL
Copy link
Mannequin

StevenHsuYL mannequin commented Jul 4, 2021

BPO 44561
Nosy @ncoghlan, @merwok, @miss-islington, @iritkatriel, @StevenHsuYL
PRs
  • bpo-44561: Update hyperlinks in Doc/distributing/index.rst #27027
  • bpo-44561: Update hyperlinks in Doc/distributing/index.rst #27032
  • [3.9] bpo-44561: Update hyperlinks in Doc/distributing/index.rst (GH-27032) #27233
  • [3.10] bpo-44561: Update hyperlinks in Doc/distributing/index.rst (GH-27032) #27234
    		•
    Files
  • index.rst: https://github.com/python/cpython/blob/main/Doc/distributing/index.rst
    		•

    Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.

    Show more details

    GitHub fields:

    assignee = None
closed_at = <Date 2021-07-19.03:00:55.509>
created_at = <Date 2021-07-04.13:33:38.393>
labels = ['3.11', 'type-feature', '3.9', '3.10', 'docs']
title = 'Some expired hyperlinks in Python documentation'
updated_at = <Date 2021-07-28.13:37:56.212>
user = 'https://github.com/StevenHsuYL'

    bugs.python.org fields:

    activity = <Date 2021-07-28.13:37:56.212>
actor = 'eric.araujo'
assignee = 'docs@python'
closed = True
closed_date = <Date 2021-07-19.03:00:55.509>
closer = 'StevenHsuYL'
components = ['Documentation']
creation = <Date 2021-07-04.13:33:38.393>
creator = 'StevenHsuYL'
dependencies = []
files = ['50139']
hgrepos = []
issue_num = 44561
keywords = ['patch']
message_count = 9.0
messages = ['396941', '396960', '397068', '397768', '397770', '397771', '397776', '397777', '398382']
nosy_count = 6.0
nosy_names = ['ncoghlan', 'eric.araujo', 'docs@python', 'miss-islington', 'iritkatriel', 'StevenHsuYL']
pr_nums = ['27027', '27032', '27233', '27234']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue44561'
versions = ['Python 3.9', 'Python 3.10', 'Python 3.11']
    @StevenHsuYL
    Copy link
    Mannequin Author

    StevenHsuYL mannequin commented Jul 4, 2021

    In https://github.com/python/cpython/blob/main/Doc/distributing/index.rst, there are three expired hyperlinks:

    .. _Project structure: \
    https://packaging.python.org/tutorials/distributing-packages/
    .. _Building and packaging the project: \
    https://packaging.python.org/tutorials/distributing-packages/#packaging-your-project
    .. _Uploading the project to the Python Packaging Index: \
    https://packaging.python.org/tutorials/distributing-packages/#uploading-your-project-to-pypi

    And it should be fixed in this way:

    .. _Project structure: \
    https://packaging.python.org/tutorials/packaging-projects/#packaging-python-projects
    .. _Building and packaging the project: \
    https://packaging.python.org/tutorials/packaging-projects/#creating-the-package-files
    .. _Uploading the project to the Python Packaging Index: \
    https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives

    Thanks.

    @StevenHsuYL StevenHsuYL mannequin added the 3.9 only security fixes label Jul 4, 2021
    @StevenHsuYL StevenHsuYL mannequin assigned docspython Jul 4, 2021
    @StevenHsuYL StevenHsuYL mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement 3.9 only security fixes labels Jul 4, 2021
    @StevenHsuYL StevenHsuYL mannequin assigned docspython Jul 4, 2021
    @StevenHsuYL StevenHsuYL mannequin added docs Documentation in the Doc dir type-feature A feature request or enhancement labels Jul 4, 2021
    @iritkatriel
    Copy link
    Member

    Thanks, do you mind creating a github PR to fix this?

    @StevenHsuYL
    Copy link
    Mannequin Author

    StevenHsuYL mannequin commented Jul 7, 2021

    I have make a new PR (bpo-27032), and the CLA was signed.
    Thanks for review.

    @StevenHsuYL StevenHsuYL mannequin removed 3.9 only security fixes labels Jul 7, 2021
    @iritkatriel iritkatriel added 3.9 only security fixes 3.10 only security fixes 3.11 only security fixes labels Jul 7, 2021
    @ncoghlan
    Copy link
    Contributor

    New changeset b494685 by Steven Hsu in branch 'main':
    bpo-44561: Update hyperlinks in Doc/distributing/index.rst (bpo-27032)
    b494685

    @miss-islington
    Copy link
    Contributor

    New changeset bce2847 by Miss Islington (bot) in branch '3.10':
    [3.10] bpo-44561: Update hyperlinks in Doc/distributing/index.rst (GH-27032) (GH-27234)
    bce2847

    @miss-islington
    Copy link
    Contributor

    New changeset 2f643b1 by Miss Islington (bot) in branch '3.9':
    [3.9] bpo-44561: Update hyperlinks in Doc/distributing/index.rst (GH-27032) (GH-27233)
    2f643b1

    @merwok
    Copy link
    Member

    merwok commented Jul 19, 2021

    This can be closed. Thanks for the patch!

    For next time, such small doc fixes don’t need a NEWS entry.

    @StevenHsuYL
    Copy link
    Mannequin Author

    StevenHsuYL mannequin commented Jul 19, 2021

    Thanks for reminding.
    In the beginning, I didn't add a NEWS entry in the PR (bpo-27032).

    However, after 11 days when there was no progress of the PR, I doubted that maybe I missed something, so I made a NEWS entry to make sure.

    And soon after the NEWS entry was added, the PR was processed quickly.

    Anyway, it's a interesting experience for me, and thanks again!

    @StevenHsuYL StevenHsuYL mannequin closed this as completed Jul 19, 2021
    @StevenHsuYL StevenHsuYL mannequin closed this as completed Jul 19, 2021
    @merwok
    Copy link
    Member

    merwok commented Jul 28, 2021

    Python has thousands of open issues and PRs, so that’s why the one you opened didn’t have comments at first.

    For cases like this, there is a 'skip-news' label to satisfy the robotic checks.

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees
    No one assigned
    Labels
    3.9 only security fixes 3.10 only security fixes 3.11 only security fixes docs Documentation in the Doc dir type-feature A feature request or enhancement
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    4 participants
    @merwok @ncoghlan @iritkatriel @miss-islington