DOC: Fix Documentation Typo #5748
Conversation
Reviewer ChecklistPlease leverage this checklist to ensure your code review is thorough before approving Testing, Bugs, Errors, Logs, Documentation
System Compatibility
Quality
|
|
Docs: Correct grammatical article from "a SQL" to "an SQL" across documentation This PR is a documentation-only cleanup that standardizes the phrasing "an SQL database" everywhere in the public docs, Markdoc source, generated text assets, and sample-data JSON. No application logic, APIs, or build tooling are modified. The change improves grammatical accuracy and professionalism without altering any technical content or behavior. Key Changes• Replaced all occurrences of "a SQL database" with "an SQL database" in Markdoc sources Affected Areas• docs/architecture/.md This summary was automatically generated by @propel-code-bot |
![propel-code-bot[bot]](https://avatars.githubusercontent.com/in/1179004?s=60&v=4){kind=small}
|
|
||
| This error happens when the HNSW index fails to retrieve the requested number of results for a query, given its structure and your data. he way to resolve this is to either decrease the number of results you request from a query (n_result), or increase the HNSW parameters `M`, `ef_construction`, and `ef_search`. You can read more about HNSW configurations [here](/docs/collections/configure). | ||
| This error happens when the HNSW index fails to retrieve the requested number of results for a query, given its structure and your data. The way to resolve this is to either decrease the number of results you request from a query (n_result), or increase the HNSW parameters `M`, `ef_construction`, and `ef_search`. You can read more about HNSW configurations [here](/docs/collections/configure). | ||
|
|
There was a problem hiding this comment.
[Documentation]
Parameter name appears incorrect: use n_results (plural) instead of n_result.
Note: The ChromaDB query API consistently uses n_results (plural) across all implementations. This parameter specifies the number of nearest neighbors to return for each query, with a default value of 10.
Context for Agents
[**Documentation**]
Parameter name appears incorrect: use `n_results` (plural) instead of `n_result`.
Note: The ChromaDB query API consistently uses `n_results` (plural) across all implementations. This parameter specifies the number of nearest neighbors to return for each query, with a default value of 10.
File: docs/docs.trychroma.com/markdoc/content/docs/overview/troubleshooting.md
Line: 30| ## Cannot return the results in a contiguous 2D array. Probably ef or M is too small | ||
|
|
||
| This error happens when the HNSW index fails to retrieve the requested number of results for a query, given its structure and your data. he way to resolve this is to either decrease the number of results you request from a query (n_result), or increase the HNSW parameters `M`, `ef_construction`, and `ef_search`. You can read more about HNSW configurations [here](/docs/collections/configure). | ||
| This error happens when the HNSW index fails to retrieve the requested number of results for a query, given its structure and your data. The way to resolve this is to either decrease the number of results you request from a query (n_result), or increase the HNSW parameters `M`, `ef_construction`, and `ef_search`. You can read more about HNSW configurations [here](/docs/collections/configure). |
There was a problem hiding this comment.
[Documentation]
Parameter name appears incorrect: use n_results (plural) instead of n_result.
Note: The ChromaDB query API consistently uses n_results (plural) across all implementations. This parameter specifies the number of nearest neighbors to return for each query, with a default value of 10.
Context for Agents
[**Documentation**]
Parameter name appears incorrect: use `n_results` (plural) instead of `n_result`.
Note: The ChromaDB query API consistently uses `n_results` (plural) across all implementations. This parameter specifies the number of nearest neighbors to return for each query, with a default value of 10.
File: docs/docs.trychroma.com/public/llms-docs-overview-troubleshooting.txt
Line: 24|
|
||
| This error happens when the HNSW index fails to retrieve the requested number of results for a query, given its structure and your data. he way to resolve this is to either decrease the number of results you request from a query (n_result), or increase the HNSW parameters `M`, `ef_construction`, and `ef_search`. You can read more about HNSW configurations [here](/docs/collections/configure). | ||
| This error happens when the HNSW index fails to retrieve the requested number of results for a query, given its structure and your data. The way to resolve this is to either decrease the number of results you request from a query (n_result), or increase the HNSW parameters `M`, `ef_construction`, and `ef_search`. You can read more about HNSW configurations [here](/docs/collections/configure). | ||
|
|
There was a problem hiding this comment.
[Documentation]
Parameter name appears incorrect: use n_results (plural) instead of n_result.
Note: The ChromaDB query API consistently uses n_results (plural) across all implementations. This parameter specifies the number of nearest neighbors to return for each query, with a default value of 10.
Context for Agents
[**Documentation**]
Parameter name appears incorrect: use `n_results` (plural) instead of `n_result`.
Note: The ChromaDB query API consistently uses `n_results` (plural) across all implementations. This parameter specifies the number of nearest neighbors to return for each query, with a default value of 10.
File: docs/docs.trychroma.com/public/llms-full.text
Line: 30451 participant
Fix Typo in trychroma.com guide