-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add note about requirements for Markdown descriptions #481
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
Comments
I'm working on this.
before the box with the example code. |
Given the confusion with pypi/warehouse#4099, we should probably also indicate that the upload must be performed with We could also provide a helpful command to run to ensure all versions are up to date, like |
^ Yes please!
Took me a silly amount of stack overflow digging to figure this out.. |
I drafted a concise note including the above details:
Could you please review the content and the structure of the draft, @di and @theacodes ? |
Looks good enough to start with, send a PR? |
@theacodes and @di, I added a note at what I thought would be an appropriate place in the existing doc. I'll appreciate your feedback, suggestions and corrections to be made. Thank you! |
A lot of users are getting bit when first trying to publish when their first Markdown description because various tools they're using are out of date:
When we're talking about
long_description_content_type
orDescription-Content-Type
in this guide, we should probably add a note or caveat about requiring the following versions for it to work:setuptools>=38.6.0
wheel>=0.31.0
twine>=1.11.0
The text was updated successfully, but these errors were encountered: