chore: improves documentation and readme #65

2025-11-26T12:50:23Z

HideyoshiNakazone commented

2025-11-26 12:50:23 +00:00

(Migrated from github.com)

This pull request updates documentation to clarify the two APIs for building models with SchemaConverter, highlights the new instance API and its reference cache, and adds usage examples and warnings about potential schema/type name collisions. The changes help users understand when to use each API and how to avoid cache-related issues.

Documentation improvements for usage and cache control

Added a clear explanation in README.md of the two APIs (build and build_with_cache) for generating Pydantic models, including guidance on reference cache management and when to use each API.
Introduced detailed usage examples for both the static and instance APIs in README.md, demonstrating how to build models, access cached references, and clear the cache.
Added a warning in docs/source/usage.rst and expanded guidance in docs/source/usage.ref_cache.rst about possible schema and type name collisions when using the instance API and reference cache, recommending separate SchemaConverter instances per namespace or schema source. [1] [2]

Minor documentation and formatting updates

Updated badge formatting and improved alt text for images in README.md.
Fixed minor wording and grammar in feature descriptions and API explanations in README.md and docs/source/usage.rst. [1] [2]

This pull request updates documentation to clarify the two APIs for building models with `SchemaConverter`, highlights the new instance API and its reference cache, and adds usage examples and warnings about potential schema/type name collisions. The changes help users understand when to use each API and how to avoid cache-related issues. ### Documentation improvements for usage and cache control * Added a clear explanation in `README.md` of the two APIs (`build` and `build_with_cache`) for generating Pydantic models, including guidance on reference cache management and when to use each API. * Introduced detailed usage examples for both the static and instance APIs in `README.md`, demonstrating how to build models, access cached references, and clear the cache. * Added a warning in `docs/source/usage.rst` and expanded guidance in `docs/source/usage.ref_cache.rst` about possible schema and type name collisions when using the instance API and reference cache, recommending separate `SchemaConverter` instances per namespace or schema source. [[1]](diffhunk://#diff-66e28562c85a1bb96f431f2dd52bbabab914359e4b06f58eb1e18eadc01f5c06R100-R104) [[2]](diffhunk://#diff-49841fb126d70aa2f7d8735416eae7f32b0a5f6ea92830b7c8c355b513c22610R13-R18) ### Minor documentation and formatting updates * Updated badge formatting and improved alt text for images in `README.md`. * Fixed minor wording and grammar in feature descriptions and API explanations in `README.md` and `docs/source/usage.rst`. [[1]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L22-R28) [[2]](diffhunk://#diff-66e28562c85a1bb96f431f2dd52bbabab914359e4b06f58eb1e18eadc01f5c06L45-R45)

codecov[bot] commented

2025-11-26 12:50:27 +00:00

(Migrated from github.com)

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

## [Codecov](https://app.codecov.io/gh/HideyoshiNakazone/jambo/pull/65?dropdown=coverage&src=pr&el=h1&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Vitor+Hideyoshi) Report :white_check_mark: All modified and coverable lines are covered by tests. :loudspeaker: Thoughts on this report? [Let us know!](https://github.com/codecov/feedback/issues/255)

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: HideyoshiNakazone/jambo#65