fix examples in readme to match latest output formats#217
Merged
avendesora merged 3 commits intomainfrom Nov 12, 2025
Merged
Conversation
Contributor
Reviewer's guide (collapsed on small PRs)Reviewer's GuideThe 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 READMEclassDiagram
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
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferences |
… analysis workflow
… analysis workflow
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Update examples in README
Checklist:
Summary by Sourcery
Update README examples to reflect the latest NormalizedReference signature and output formatting
Documentation: