docs: fix DatabaseFactory.create() call signature - #68
Conversation
DatabaseFactory.create() takes host/port as direct keyword arguments, not a config dict. The documented example raised TypeError.
|
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 |
The automated sentinels have completed their watch. 💂♂️I've aggregated the results of the automated checks for this PR below. 🔍 LintThe results have been compiled and are ready for review. 📑 ❌ ruff: issues found — see job log 🔒 Security (pip-audit)Ensuring our code is secure by design. 📐 ✅ No known vulnerabilities found (70 packages scanned). ⚖️ License CheckEnsuring our EULA (if any) is still valid. 📑 ✅ No license violations found. Policy: Apache 2.0 (universal donor). StrongCopyleft / NetworkCopyleft / WeakCopyleft / Other / Error categories fail. MPL allowed. 📋 Repo HealthThe repo's annual physical is complete! 🩺 ✅ All required files present. Latest Version: ✅ 🏷️ Release PreviewI've checked the countdown clock for the next release. ⏰ Current:
✅ PR title follows conventional commit format. 🚀 Release Channel Compatibility Predicted next version:
📊 CoverageA comprehensive review of our code coverage. 📖 ✅ 85.6% total coverage Per-file coverage (2 files)
Full report: download the 🔨 Build TestsAssembling the puzzle pieces of your PR. 🧩
❌ 3.10: Install OK, tests failed Crafting a better voice assistant, one commit at a time 🎙️ |
docs/operations.mdshowed a cross-backend migration example callingDatabaseFactory.create("hivemind-redis-db-plugin", config={"host": ..., "port": ...}).The real signature (
hivemind_plugin_manager/__init__.py,DatabaseFactory.create) takeshostandportas direct keyword arguments; there is noconfigparameter. Running thedocumented snippet against the current
hivemind-plugin-manager(checked against the localeditable install, 0.9.0a6, and the origin/dev source) raises:
Fixed the example to pass
host=andport=directly. No other claim in this repo's READMEor docs/ (entry-point name, config keys and defaults, schema version, migration behavior) was
found to be inaccurate against source.