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

Add absolute URLs to README to improve PyPI summary #373

Merged
merged 1 commit into from
Jun 7, 2024

Conversation

rich-iannone
Copy link
Member

This modifies the links to images in the README. Previously we used relative links to graphics assets in the repo to specify image locations. Since PyPI copies the README, the images are broken with every re-publication of the project description (at every release). These changes should ensure that the rendered page will display images, since the relative links have been changed to absolute links.

@rich-iannone rich-iannone requested a review from machow June 6, 2024 21:24
Copy link

codecov bot commented Jun 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.77%. Comparing base (b6aa4f8) to head (5539f64).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #373   +/-   ##
=======================================
  Coverage   86.77%   86.77%           
=======================================
  Files          42       42           
  Lines        4546     4546           
=======================================
  Hits         3945     3945           
  Misses        601      601           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@machow machow left a comment

Choose a reason for hiding this comment

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

LGTM thanks!

@machow machow merged commit 7f65def into main Jun 7, 2024
13 checks passed
@rich-iannone rich-iannone deleted the update-readme-images branch June 7, 2024 13:46
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.

2 participants