[fix] correct typos / wrong examples / mislabeled params in aggregate, AI, and array function docs#3706
Merged
Conversation
…, AI, and array function docs
- stddev.md: Return Value said "sample standard deviation"; STDDEV / STDDEV_POP compute the population standard deviation (STDDEV_SAMP is the sample variant). Corrected in English and Chinese copies.
- inner-product-approximate.md / inner-product.md / array-cross-product.md: the Parameters table had both rows labeled `<array1>`; second row corrected to `<array2>`.
- inner-product-approximate.md: the example query called `L2_distance_approximate(...)`; changed to `inner_product_approximate(...)`.
- ai-summarize.md / ai-translate.md: typo `'resourse_name'` -> `'resource_name'`.
- ai-classify.md: sample label `'useage'` -> `'usage'`.
- array-avg.md: the "Array is NULL" example called `array_max(NULL)` (copy-paste from array-max.md); changed to `array_avg(NULL)`.
- array-product.md: example `array_product([1.1, 2.2, 3.3, 4.4, 5.5])` showed `190.8`; the actual product is `193.2612`.
- array-reverse-split.md / array-split.md: result string `[[1,[NULL,3]]` had mismatched brackets; corrected to `[[1, NULL, 3]]`.
- array-union.md: result table header was `ARRAY_UNION(ARRAY('hello', 'world'), ARRAY('hello', NULL))` while the query was `ARRAY_UNION(ARRAY('hello', 'world', 'hello'), ARRAY('hello', NULL))`; header now matches the query (ruler/padding widened to keep the table aligned).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Fixes 13 small documentation issues across the aggregate, AI, and array function references. Each item below is independent.
STDDEV/STDDEV_POPcompute the population standard deviation (STDDEV_SAMPis the sample variant). Corrected the English and Chinese copies.\`. Changed to``` to match the function signature.L2_distance_approximate(embedding, ...)(the function being documented isINNER_PRODUCT_APPROXIMATE). Changed the call toinner_product_approximate(...).'resourse_name'→'resource_name'.'useage'→'usage'.array_max(NULL)(looked like a copy-paste fromarray-max.md). Changed toarray_avg(NULL).array_product([1.1, 2.2, 3.3, 4.4, 5.5])showed a result of190.8. The actual product is193.2612.[[1,[NULL,3]]had mismatched brackets; corrected to[[1, NULL, 3]].ARRAY('hello', 'world', 'hello')) showed only 2 elements. Header now matches the query; ruler and right-edge padding widened to keep the table aligned.Test plan