Skip to content

Conversation

@Muthusrihemadharshini
Copy link

This PR fixes several broken and outdated external links in the documentation,
identified during the HTTPS link audit.

This is a documentation-only change, so no news fragment is required.

Fixes part of #13664.

Copilot AI review requested due to automatic review settings December 16, 2025 10:39
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes broken and outdated external documentation links as part of an HTTPS link audit. While the PR successfully updates some PyPI URLs to use HTTPS and fixes link formatting, there are issues with two changes where example URLs were completely removed, leaving incomplete documentation.

Key Changes

  • Updated PyPI URLs from HTTP to HTTPS protocol in NEWS.rst and overview.rst
  • Removed example.com URLs from user guide documentation (incomplete - needs proper replacement)
  • Fixed malformed reStructuredText link syntax in architecture documentation

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 4 comments.

File Description
docs/html/user_guide.rst Attempts to remove outdated example.com URLs but leaves incomplete sentence fragments without proper URL examples
docs/html/development/architecture/overview.rst Updates PyPI Simple API link to HTTPS and fixes RST syntax, though link text still shows HTTP protocol
NEWS.rst Successfully updates historical PyPI mirrors link from HTTP to HTTPS

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 130 to 132
Requirements files can also be served via a URL, e.g.
requirements.txt besides as local files, so that they can
be stored and served in a centralized place.
Copy link

Copilot AI Dec 16, 2025

Choose a reason for hiding this comment

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

The example in this line is incomplete. After removing the example URL, the text now reads "e.g. requirements.txt" which is not a valid URL example. Consider using a placeholder URL like "https://example.com/requirements.txt" instead, or rephrase the sentence to make it clear that any URL can be used without providing a specific example.

Suggested change
Requirements files can also be served via a URL, e.g.
requirements.txt besides as local files, so that they can
be stored and served in a centralized place.
Requirements files can also be served via a URL (for example, https://example.com/requirements.txt), in addition to being used as local files. This allows them
to be stored and served in a centralized place.

Copilot uses AI. Check for mistakes.

Same as requirements files, constraints files can also be served via a URL,
e.g. http://example.com/constraints.txt, so that your organization can store and
e.g. constraints.txt, so that your organization can store and
Copy link

Copilot AI Dec 16, 2025

Choose a reason for hiding this comment

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

The example in this line is incomplete. After removing the example URL, the text now reads "e.g. constraints.txt" which is not a valid URL example. Consider using a placeholder URL like "https://example.com/constraints.txt" instead, or rephrase the sentence to make it clear that any URL can be used without providing a specific example.

Suggested change
e.g. constraints.txt, so that your organization can store and
e.g. https://example.com/constraints.txt, so that your organization can store and

Copilot uses AI. Check for mistakes.

1. Following the API defined in :pep:`503`, fetch the index page from
`http://{pypi_index}/simple/{package_name <http://pypi.org/simple/%7Bpackage_name>`__}
`http://{pypi_index}/simple/{package_name} <https://pypi.org/simple/{package_name}>`_
Copy link

Copilot AI Dec 16, 2025

Choose a reason for hiding this comment

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

The link text shows "http://{pypi_index}/simple/{package_name}" but the actual URL uses HTTPS. For consistency and to avoid confusion, the link text should also use "https://" to match the actual URL protocol being linked to.

Suggested change
`http://{pypi_index}/simple/{package_name} <https://pypi.org/simple/{package_name}>`_
`https://{pypi_index}/simple/{package_name} <https://pypi.org/simple/{package_name}>`_

Copilot uses AI. Check for mistakes.

Requirements files can also be served via a URL, e.g.
http://example.com/requirements.txt besides as local files, so that they can
Requirements files can also be served via a URL, e.g.
Copy link

Copilot AI Dec 16, 2025

Choose a reason for hiding this comment

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

There is trailing whitespace at the end of this line that should be removed.

Suggested change
Requirements files can also be served via a URL, e.g.
Requirements files can also be served via a URL, e.g.

Copilot uses AI. Check for mistakes.
@Muthusrihemadharshini
Copy link
Author

pre-commit.ci autofix

@notatallshaw
Copy link
Member

You shouldn't remove example URLs, they were never intended to work. If there is a better way to display them as an example that's fine, but they need to remain URLs.

@Muthusrihemadharshini
Copy link
Author

Got it — thanks for the clarification. I’ve restored the example URLs and marked them as literals so they remain examples without triggering link checks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants