mirror of
https://github.com/lancedb/lancedb.git
synced 2026-05-14 18:40:39 +00:00
ed7e01a58b
## Problem The generated Python API docs for `lancedb.table.IndexStatistics.index_type` were misleading because mkdocstrings renders that field’s type annotation directly, and the existing `Literal[...]` listed only a subset of the actual canonical SDK index type strings. Current (missing index types): <img width="823" height="83" alt="image" src="https://github.com/user-attachments/assets/f6f29fe3-4c16-4d00-a4e9-28a7cd6e19ec" /> ## Fix - Update the `IndexStatistics.index_type` annotation in `python/python/lancedb/table.py` to include the full supported set of canonical values, so the generated docs show all valid index_type strings inline. - Add a small regression test in `python/python/tests/test_index.py` to ensure the docs-facing annotation does not drift silently again in case we add a new index/quantization type in the future. - Bumps mkdocs and material theme versions to mkdocs 1.6 to allow access to more features like hooks After fix (all index types are included and tested for in the annotations): <img width="1017" height="93" alt="image" src="https://github.com/user-attachments/assets/66c74d5c-34b3-4b44-8173-3ee23e3648ac" />
9 lines
216 B
Plaintext
9 lines
216 B
Plaintext
mkdocs==1.6.1
|
|
mkdocs-jupyter==0.24.1
|
|
mkdocs-material==9.6.23
|
|
mkdocs-autorefs>=0.5,<=1.0
|
|
mkdocstrings[python]>=0.24,<1.0
|
|
griffe>=0.40,<1.0
|
|
mkdocs-render-swagger-plugin>=0.1.0
|
|
pydantic>=2.0,<3.0
|
|
mkdocs-redirects>=1.2.0 |