docs(readme): correct stale facts after the v0.4.0 refactor#309
Merged
Conversation
- Python floor 3.8+ -> 3.11+ (matches setup.py python_requires) - add token_classification to the supported-types table (11th template) - replace the fictional BaseIngestor subclassing snippet (validators/transform class API that does not exist) with the real CSVIngestor + run_ingestion pattern Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Collaborator
Author
|
👋 Heads-up — Code review queue is at 39 / 30 Above the WIP limit. The team convention is to review existing PRs before opening new work. Open PRs currently in Code review (oldest first):
Pull from review before opening new work. (This is a nudge from the kanban WIP check, not a block.) |
shujaatTracebloc
approved these changes
Jun 18, 2026
saadqbal
added a commit
that referenced
this pull request
Jun 18, 2026
#309 (merged) already corrected the Python floor, added token_classification, and rewrote the custom-processor example. This adds the remaining stale facts it didn't touch: - Readme.md: BaseProcessor -> BaseIngestor (no BaseProcessor class exists); list run_ingestion + Config in the exports sentence - CLAUDE.md: Python 3.8+ -> 3.11+; dev install via requirements-dev.txt (runtime/dev requirements split, #246) Refs #311 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This was referenced Jun 18, 2026
saadqbal
added a commit
that referenced
this pull request
Jun 18, 2026
docs: fix README + CLAUDE.md facts not covered by #309
7 tasks
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.
Summary
Three accuracy fixes to the public README, found reviewing it against the shipped v0.4.0. The README's core (the declarative-YAML path, helm flow, metadata-only sync) is current — the refactor was internal and behavior-preserving, so no architecture rewrite is needed. These are stale facts only:
setup.py(python_requires=">=3.11", bumped in the P1 packaging phase).token_classificationto the supported-types table — it's the 11th template (templates/token_classification/) but was missing from the Text/NLP row.validators = [...]class attribute, atransform()hook, andMyIngestor().ingest()that don't exist. Replaced with the real instantiation pattern (CSVIngestor(database=, api_client=, category=, …)+run_ingestion(...)), matching thetemplates/scripts and the package's top-level exports.Type
Docs.
Test plan
Docs-only; no code change. The new example was verified against
templates/image_classification/image_classification.pyandtracebloc_ingestor/__init__.pyexports.🤖 Generated with Claude Code