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

Bug fix README logos #56

Merged
merged 1 commit into from
Sep 2, 2024
Merged

Bug fix README logos #56

merged 1 commit into from
Sep 2, 2024

Conversation

bleudev
Copy link
Member

@bleudev bleudev commented Sep 2, 2024

Description (optional)

On PyPi there wasn't ufpy logo. Now this bug may be solved.

TO-DO list (optional)

  • Fix README logos

Issue you want to close (optional)

Summary by Sourcery

Fix the display of logos in the README by updating image URLs to absolute paths to ensure they appear correctly on PyPi.

Bug Fixes:

  • Fix the issue with the README logos not displaying on PyPi by updating the image source URLs to use absolute paths.

@bleudev bleudev added the bug Something isn't working label Sep 2, 2024
@bleudev bleudev self-assigned this Sep 2, 2024
Copy link
Contributor

sourcery-ai bot commented Sep 2, 2024

Reviewer's Guide by Sourcery

This pull request fixes a bug in the README.md file where the project logo was not displaying correctly on PyPi. The changes update the image source URLs to use absolute paths pointing to the raw GitHub content, ensuring the logos are visible on external platforms.

File-Level Changes

Change Details Files
Update image source URLs in README.md to use absolute paths
  • Replace relative paths with absolute GitHub raw content URLs for the dark mode logo
  • Replace relative paths with absolute GitHub raw content URLs for the light mode logo
  • Update the fallback image source to use an absolute GitHub raw content URL
README.md

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @bleudev - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟡 Documentation: 1 issue found

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

README.md Show resolved Hide resolved
@bleudev bleudev merged commit 3f4151e into main Sep 2, 2024
@bleudev bleudev deleted the bug-fix-readme-logo branch September 2, 2024 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

1 participant