Skip to content

Conversation

@hagenw
Copy link
Member

@hagenw hagenw commented Jan 14, 2026

Removes batches from README header, and reduces links to documentation, PyPI, license. We now use emojis instead of badge images.

image

An alternative would be to not use icons

image

Discussion:

  • The "Test passing" badge did not really provided any information
  • The "Code coverage" badge is also no longer relevant as we target 100% anyway for all packages
  • If you don't like using emojis as icons, we can also do a version without any icons
  • On Github we always have these formatting issue when displaying the batches, that cannot be solved:
image

Summary by Sourcery

Documentation:

  • Update README header to use emojis instead of image badges and streamline the set of displayed links.

Summary by Sourcery

Documentation:

  • Streamline the README header by removing legacy status/coverage badges and using concise emoji-based links to documentation, PyPI, and license information.

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jan 14, 2026

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Updates the README header to remove legacy badge images and replace them with a simplified set of emoji-based links to key project resources (docs, PyPI, license).

File-Level Changes

Change Details Files
Simplify the README header by replacing image badges with emoji-based links and pruning non-essential badges.
  • Remove CI status and code coverage image badges from the README header
  • Add concise emoji-prefixed links to documentation, PyPI, and license instead of graphic badges
  • Adjust header formatting to be more compact and avoid prior badge layout/rendering issues
README.rst

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@hagenw hagenw marked this pull request as ready for review January 21, 2026 16:42
@hagenw hagenw self-assigned this Jan 21, 2026
@hagenw hagenw requested a review from frankenjoe January 21, 2026 16:43
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 - I've reviewed your changes and they look great!


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 and I'll use the feedback to improve your reviews.

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