Add comprehensive docstrings to LanceDB adapter #3956
+155
−0
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.
Add comprehensive docstrings to LanceDB adapter
Summary
This PR addresses issue #3955 by adding comprehensive Google-style docstrings to all public functions and classes in
lancedb_adapter.py. The docstrings include Args, Returns, Raises, and Example sections where appropriate, following the format requested in the issue.Changes:
LanceDBAdapterclass with detailed attribute descriptionsmodel_post_init(),query(), andadd()_default_embedding_function()helper functiontest_lancedb_adapter_docs.pyto verify docstrings exist and contain required sectionsReview & Testing Checklist for Human
query()andadd()method examplesTest Plan
uv run pytest lib/crewai-tools/tests/adapters/test_lancedb_adapter_docs.py -vvto verify all docstring tests passNotes
pytest.importorskip("lancedb")to skip tests if LanceDB is not installed (it's an optional dependency)Link to Devin run: https://app.devin.ai/sessions/0e6f94a041a64b3e9b982fde27c9f66d
Requested by: João ([email protected])
Closes #3955