Skip to content

update known issues & planned improvements in README#102

Merged
MusicalNinjaDad merged 1 commit into
mainfrom
readme
Nov 6, 2025
Merged

update known issues & planned improvements in README#102
MusicalNinjaDad merged 1 commit into
mainfrom
readme

Conversation

@MusicalNinjaDad

@MusicalNinjaDad MusicalNinjaDad commented Nov 6, 2025 •
edited by sourcery-ai Bot
Loading

Copy link
Copy Markdown
Owner

Summary by Sourcery

Add a Known limitations section to the README and update the Planned improvements list with a performance enhancement.

Documentation:

  • Introduce a "Known limitations" section listing current issues with symlink recursion, interpreter handling, and custom RUNPATH/RPATH binaries
  • Remove the planned error type and CLI exit code handling improvement
  • Add a new planned improvement to bail early on errors for performance gains

@sourcery-ai

sourcery-ai Bot commented Nov 6, 2025 •
edited
Loading

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

This PR enhances the project documentation by adding a 'Known limitations' section outlining current shortcomings and updating the 'Planned improvements' list with a new performance-related item.

File-Level Changes

Change Details Files
Introduced a 'Known limitations' section in README
  • Added heading for known limitations
  • Documented lack of recursion into symlinked subdirectories
  • Noted limitation on interpreter-handling for dynamic and static binaries
  • Highlighted missing support for custom RUNPATH/RPATH dependencies
 README.md
Updated 'Planned improvements' list
  • Added bullet for performance improvement by bailing early on errors
 README.md
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

@MusicalNinjaDad MusicalNinjaDad enabled auto-merge (squash) November 6, 2025 17:06
sourcery-ai[bot]
sourcery-ai Bot reviewed Nov 6, 2025
View reviewed changes

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey there - 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.

@MusicalNinjaDad MusicalNinjaDad enabled auto-merge (squash) November 6, 2025 17:07
@MusicalNinjaDad MusicalNinjaDad merged commit 715ad37 into main Nov 6, 2025
12 checks passed
@MusicalNinjaDad MusicalNinjaDad deleted the readme branch November 6, 2025 17:08
@codecov

codecov Bot commented Nov 6, 2025

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.93%. Comparing base (3782728) to head (5081ad5).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #102   +/-   ##
=======================================
  Coverage   74.93%   74.93%           
=======================================
  Files          12       12           
  Lines         730      730           
=======================================
  Hits          547      547           
  Misses        125      125           
  Partials       58       58

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@MusicalNinjaDad