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

Fix linkcheck #147

Merged
merged 2 commits into from
Jan 24, 2024
Merged

Fix linkcheck #147

merged 2 commits into from
Jan 24, 2024

Conversation

cclauss
Copy link
Contributor

@cclauss cclauss commented Jan 24, 2024

No description provided.

@@ -240,6 +240,7 @@ package:
Maintainer tasks
================


Copy link
Collaborator

Choose a reason for hiding this comment

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

This isn't really needed?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Needed...

 validate-pyproject git:(fix-linkcheck) ✗ reading sources... [100%] readme .. schemas

CONTRIBUTING.rst:243: CRITICAL: Title level inconsistent:

Releases
--------

Copy link
Owner

@abravalheri abravalheri Jan 24, 2024

Choose a reason for hiding this comment

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

So that is how to fix this warning!

The rst spec is surprisingly pedantic O.o

Copy link
Collaborator

Choose a reason for hiding this comment

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

Wow, nice find. 😮

@abravalheri abravalheri merged commit 999ffb1 into abravalheri:main Jan 24, 2024
29 checks passed
@cclauss cclauss deleted the fix-linkcheck branch January 24, 2024 19:35
@@ -1,7 +1,7 @@
{
"$schema": "http://json-schema.org/draft-07/schema#",

"$id": "https://packaging.python.org/en/latest/specifications/declaring-build-dependencies/",
"$id": "https://packaging.python.org/en/latest/specifications/dependency-specifiers/",
Copy link
Owner

Choose a reason for hiding this comment

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

I see that this new ref fix linkcheck however it is not the best reference.
The new PyPA docs now unify both the [build-system] table and the [project] table into a single URL: https://packaging.python.org/en/latest/specifications/pyproject-toml/.

We could try to use fragments like in https://packaging.python.org/en/latest/specifications/pyproject-toml/#pyproject-build-system-table, but I have the impression that this will confuse the validation (I might be wrong though).

For the time being we can live as it is, because it is not hurting anyone...
The folks maintaining the docs are currently having a look on what happened to the redirect: pypa/packaging.python.org#1486.

@cclauss is it OK if once they finished debugging the redirects we return the old URL? It is going to be a 30X status, I am not sure if that will fail the linkcheck... Alternatively we can test the fragments and see if they actually break something...

Copy link
Contributor Author

@cclauss cclauss Jan 24, 2024

Choose a reason for hiding this comment

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

Please go ahead and revert the specification changes if you think that is the right thing to do.

The old URLs do not exist (404 error) but those were only warnings, not errors in linkcheck.

The linkcheck error was that blank line!

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

Successfully merging this pull request may close these issues.

3 participants