Skip to content

Conversation

@avendesora
Copy link
Owner

@avendesora avendesora commented Nov 12, 2025

Description

Update examples in README

Checklist:

  • I have read the CONTRIBUTING document.
  • I have added tests that prove my fix is effective or that my feature works.
  • I have run pre-commit locally prior to submission and fixed any errors/warnings.
  • I have run tests locally prior to submission and they are passing.
  • I have added necessary documentation (if appropriate).
  • I have updated the README (if appropriate).
  • I have updated the CHANGELOG (if appropriate).
  • I have updated the version number (if appropriate).
  • I have updated the requirements (if appropriate).

Summary by Sourcery

Update README examples to reflect the latest NormalizedReference signature and output formatting

Documentation:

  • Update README examples to include the end_book parameter in NormalizedReference calls
  • Change verse_id outputs in README examples from list notation to tuple notation

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Nov 12, 2025

Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

The README examples were updated to reflect the latest API changes, ensuring that NormalizedReference now requires an end_book parameter and the conversion output is shown as a tuple.

Class diagram for updated NormalizedReference usage in README

classDiagram
    class NormalizedReference {
        +Book book
        +int start_chapter
        +int start_verse
        +int end_chapter
        +int end_verse
        +Book end_book
    }
    class Book {
        <<enumeration>>
    }
    NormalizedReference --> Book : uses
Loading

File-Level Changes

Change Details Files
Include the end_book argument in NormalizedReference examples
  • Added bible.Book.GENESIS as the end_book in the Genesis example
  • Replaced None with <Book.MATTHEW: 40> for Matthew ranges
  • Replaced None with <Book.LUKE: 42> for Luke ranges
README.md
Update verse ID output format in examples
  • Changed the displayed output from a list to a tuple
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

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

@codacy-production
Copy link

codacy-production bot commented Nov 12, 2025

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (8801a35) 2063 2063 100.00%
Head commit (76ffd33) 2063 (+0) 2063 (+0) 100.00% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#217) 0 0 ∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

@avendesora avendesora merged commit 9a2af38 into main Nov 12, 2025
9 checks passed
@avendesora avendesora deleted the update-readme branch November 12, 2025 01:37
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