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

Update PyPiDescription.rst #2445

Merged
merged 9 commits into from
Jul 18, 2023
Merged

Update PyPiDescription.rst #2445

merged 9 commits into from
Jul 18, 2023

Conversation

bryanwweber
Copy link
Contributor

Fix the link to the README on PyPI. Use python -m pip for installation.

Checklist:

  • Did you have fun?

Fix the link to the README on PyPI. Use python -m pip for installation.
This will format more nicely on PyPI
@agunapal
Copy link
Collaborator

@msaroufim If the current URL is incorrect, any idea how its working?

@codecov
Copy link

codecov bot commented Jul 12, 2023

Codecov Report

Merging #2445 (bb895b6) into master (5390025) will not change coverage.
The diff coverage is n/a.

❗ Current head bb895b6 differs from pull request most recent head 8e9d78e. Consider uploading reports for the commit 8e9d78e to get more accurate results

@@           Coverage Diff           @@
##           master    #2445   +/-   ##
=======================================
  Coverage   71.89%   71.89%           
=======================================
  Files          78       78           
  Lines        3654     3654           
  Branches       58       58           
=======================================
  Hits         2627     2627           
  Misses       1023     1023           
  Partials        4        4           
Impacted Files Coverage Δ
setup.py 0.00% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@bryanwweber
Copy link
Contributor Author

I'm sorry, I didn't provide any context for these changes! My mistake, I submitted the PR and then forgot about it.

I was browsing PyPI and noticed that the content formatting is not correct:
image
I believe at some point, PyPI defaulted to assuming that the long_description is Markdown formatted, so the setup.py changes fix the text format type so that the README will be displayed properly. In addition, the url link is missing the blob/master portion, so it returns 404 from GitHub. This only affects the URL displayed in the PyPI user interface, it it is correct for the root-level setup.py. Finally, the same problem occurs in the PypiDescription.rst as far as the link is concerned.

Thanks for reviewing!

@agunapal agunapal merged commit 754c2f9 into pytorch:master Jul 18, 2023
11 of 12 checks passed
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