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

Uploading a correctly formatted README.rst fails #15771

Closed
Gouvernathor opened this issue Apr 14, 2024 · 1 comment
Closed

Uploading a correctly formatted README.rst fails #15771

Gouvernathor opened this issue Apr 14, 2024 · 1 comment
Labels
not-this-repo For any issues that are not for this repository

Comments

@Gouvernathor
Copy link

Describe the bug
I'm trying to publish my package but it gets rejected with error 400 saying that "the description failed to render".
Previous to that, the runner falsely claimed that my readme file had wrong syntax with wrong indentation at line 25 : it is not true because github displays it correctly and no other indentation at that line yields the same result.
On a sidenote, providing no readme at all also fails, though that block may not be at the upload level.

Expected behavior
The package publication should work.

To Reproduce
Try to upload a package with my readme, or any recursive bullet list with line wrapping.

My Platform
I think that's called GitHub Actions

@Gouvernathor Gouvernathor added bug 🐛 requires triaging maintainers need to do initial inspection of issue labels Apr 14, 2024
@miketheman
Copy link
Member

miketheman commented Apr 14, 2024

Hello!

it is not true because github displays it correctly and no other indentation at that line yields the same result.

First off, PyPI and GitHub may not share same RST parsers, so there's no expectation of equivalent behavior.

Your example is actually called out in the RST specification as an incorrect example of nested lists.
See https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#bullet-lists

So if you believe this is an issue with the specification and/or the docutils library that handles the parsing, I'd advise you to raise it with those maintainers.

You might also want to test your description with twine check - see https://twine.readthedocs.io/en/stable/#twine-check

This is already noted in the FAQ here: https://pypi.org/help/#description-render-failure

@miketheman miketheman closed this as not planned Won't fix, can't repro, duplicate, stale Apr 14, 2024
@miketheman miketheman added not-this-repo For any issues that are not for this repository and removed requires triaging maintainers need to do initial inspection of issue bug 🐛 labels Apr 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
not-this-repo For any issues that are not for this repository
Projects
None yet
Development

No branches or pull requests

2 participants