docs: fix unreachable case-insensitive confidence claim - #90
Conversation
The confidence table listed a -0.05 penalty for case-insensitive matches, but calc_intent lowercases both queries and patterns before matching (OVOS-INTENT-1 normalization), so that code path is never reached through the public API.
|
Important Draft PR not reviewedDraft PRs are not automatically reviewed by default.
To automatically review draft PRs, update your CodeRabbit configuration: reviews:
auto_review:
drafts: trueThanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Another day, another set of automated checks. Let's see! 🌅I've aggregated the results of the automated checks for this PR below. 📋 Repo HealthGiving the repo a clean bill of health! 🛁 ✅ All required files present. Latest Version: ✅ 🔒 Security (pip-audit)Checking for any insecure data transmissions. 📡 ✅ No known vulnerabilities found (49 packages scanned). ⚖️ License CheckScanning for any non-commercial-only restrictions. 💰 ✅ No license violations found. Policy: Apache 2.0 (universal donor). StrongCopyleft / NetworkCopyleft / WeakCopyleft / Other / Error categories fail. MPL allowed. 📊 CoverageTesting the resilience of our codebase. 🧱 ✅ 80.4% total coverage Per-file coverage (3 files)
Full report: download the 🔍 LintI've gathered the facts for your review. 📖 ❌ ruff: issues found — see job log 🔌 Plugin DetectionEnsuring the plugin is 'future-proof'. 🔮 ❌ Plugin Status: ERRORS (1) Plugin Info:
OPM Detection:
Entry Point Validation:
⊘ No Issues:
🔨 Build TestsBuild test complete! Let's see if everything fits together. 🧩 ✅ All versions pass
Processing... Done! Have a productive day! ☕ |
The README confidence table claimed a case-insensitive match scores -0.05. I built the package in a throwaway venv (2.3.1a1, editable install) and ran the exact quick-start example plus targeted probes for each table row.
_normalizelowercases both training samples and queries viaovos_spec_tools.normalize_for_matchbefore any matching happens, soquery_has_upperinside_matchis always False when called throughcalc_intent/calc_intents, and the case-insensitive penalty branch is unreachable through the public API.I removed the row and added a short note explaining why the case-insensitive penalty path does not fire in practice.