From c7b051aff7039333a3f61b79217246c27676806a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=99=88=E5=BF=97=E8=B0=A6?= <89645338+simpleqt@users.noreply.github.com> Date: Wed, 9 Sep 2026 04:53:38 +0800 Subject: [PATCH] docs: fix spelling typos across python package docstrings (#4146) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Six files carried spelling typos in user-visible docstrings: - `table.py` (×3) + `remote/table.py`: "The **targetted** vector to search for" → "targeted" - `query.py`: "pa.Array **wouln't** be allowed" → "wouldn't" - `embeddings/gte.py`: "mlx package **insalled**" → "installed" - `rerankers/base.py`: "This is **inteded**" → "intended" - `index.py`: "dimension **divded** by 8" → "divided" Docstrings only. --- python/python/lancedb/embeddings/gte.py | 2 +- python/python/lancedb/index.py | 2 +- python/python/lancedb/query.py | 2 +- python/python/lancedb/remote/table.py | 2 +- python/python/lancedb/rerankers/base.py | 2 +- python/python/lancedb/table.py | 6 +++--- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/python/python/lancedb/embeddings/gte.py b/python/python/lancedb/embeddings/gte.py index 9bad4b54f..10dcaf456 100644 --- a/python/python/lancedb/embeddings/gte.py +++ b/python/python/lancedb/embeddings/gte.py @@ -21,7 +21,7 @@ class GteEmbeddings(TextEmbeddingFunction): An embedding function that uses GTE-LARGE MLX format(for Apple silicon devices only) as well as the standard cpu/gpu version from: https://huggingface.co/thenlper/gte-large. - For Apple users, you will need the mlx package insalled, which can be done with: + For Apple users, you will need the mlx package installed, which can be done with: pip install mlx Parameters diff --git a/python/python/lancedb/index.py b/python/python/lancedb/index.py index 948342887..78ee72e57 100644 --- a/python/python/lancedb/index.py +++ b/python/python/lancedb/index.py @@ -751,7 +751,7 @@ class IvfPq: This value controls how much the vector is compressed during the quantization step. The more sub vectors there are the less the vector is compressed. The default is the dimension of the vector divided by 16. If - the dimension is not evenly divisible by 16 we use the dimension divded by + the dimension is not evenly divisible by 16 we use the dimension divided by 8. The above two cases are highly preferred. Having 8 or 16 values per diff --git a/python/python/lancedb/query.py b/python/python/lancedb/query.py index c76e9e7db..80927093c 100644 --- a/python/python/lancedb/query.py +++ b/python/python/lancedb/query.py @@ -859,7 +859,7 @@ class Query(pydantic.BaseModel): return query # This tells pydantic to allow custom types (needed for the `vector` query since - # pa.Array wouln't be allowed otherwise) + # pa.Array wouldn't be allowed otherwise) model_config = pydantic.ConfigDict(arbitrary_types_allowed=True) diff --git a/python/python/lancedb/remote/table.py b/python/python/lancedb/remote/table.py index 3eb9cbfa1..89b958165 100644 --- a/python/python/lancedb/remote/table.py +++ b/python/python/lancedb/remote/table.py @@ -720,7 +720,7 @@ class RemoteTable(Table): Parameters ---------- query: list/np.ndarray/str/PIL.Image.Image, default None - The targetted vector to search for. + The targeted vector to search for. - *default None*. Acceptable types are: list, np.ndarray, PIL.Image.Image diff --git a/python/python/lancedb/rerankers/base.py b/python/python/lancedb/rerankers/base.py index 7bc7ff105..4af938a1e 100644 --- a/python/python/lancedb/rerankers/base.py +++ b/python/python/lancedb/rerankers/base.py @@ -175,7 +175,7 @@ class Reranker(ABC): if the results haven't been executed yet or the results in arrow format. query : str or None, The input query. Some rerankers might not need the query to rerank. - In that case, it can be set to None explicitly. This is inteded to + In that case, it can be set to None explicitly. This is intended to be handled by the reranker implementations. deduplicate : bool, optional Whether to deduplicate the results based on the `_rowid` column, diff --git a/python/python/lancedb/table.py b/python/python/lancedb/table.py index 127ad3722..6b9f450db 100644 --- a/python/python/lancedb/table.py +++ b/python/python/lancedb/table.py @@ -1619,7 +1619,7 @@ class Table(ABC): Parameters ---------- query: list/np.ndarray/str/PIL.Image.Image, default None - The targetted vector to search for. + The targeted vector to search for. - *default None*. Acceptable types are: list, np.ndarray, PIL.Image.Image @@ -3841,7 +3841,7 @@ class LanceTable(Table): Parameters ---------- query: list/np.ndarray/str/PIL.Image.Image, default None - The targetted vector to search for. + The targeted vector to search for. - *default None*. Acceptable types are: list, np.ndarray, PIL.Image.Image @@ -5814,7 +5814,7 @@ class AsyncTable: Parameters ---------- query: list/np.ndarray/str/PIL.Image.Image, default None - The targetted vector to search for. + The targeted vector to search for. - *default None*. Acceptable types are: list, np.ndarray, PIL.Image.Image