[doc](agg) add doc for aggregate function entropy#3412
[doc](agg) add doc for aggregate function entropy#3412wrlcke wants to merge 4 commits intoapache:masterfrom
Conversation
|
/review |
There was a problem hiding this comment.
Code Review Summary — PR #3412: Add doc for aggregate function ENTROPY
Goal & Implementation
This PR adds English and Chinese documentation for the new ENTROPY aggregate function, along with a sidebar entry in sidebars.ts. The goal is clear and the implementation largely satisfies it. The doc follows the required sections (Description, Syntax, Parameters, Return Value, Examples).
Critical Checkpoint Conclusions
1. Does the implementation satisfy the goal?
Partially. All required sections are present. However, there are two concrete bugs in the Examples section and a minor formatting issue.
2. Is the change as small, clear, and focused as possible?
Yes. Only two new doc files and one sidebar entry are added. No unrelated changes.
3. Information architecture — versioned docs, localized docs, sidebars, config
sidebars.ts(current/dev) is updated correctly. Alphabetical placement (aftercovar-samp, beforegroup-array-intersect) is correct.- Only
docs/(current) andi18n/zh-CN/.../current/are added. The PR checklist marks onlydev, consistent withentropynot appearing inversioned_docs/version-4.x/orversion-3.x/. No versioned sidebar changes are needed for this scope.
4. Path / anchor / slug / navigation consistency
No renames or deletions. New paths follow the existing convention. No redirect issues.
5. Docusaurus config / React / styling
No changes to components, styling, or build scripts.
6. Validation
No test cases have been built (checkbox unchecked in PR). Example outputs should be verified against a running Doris instance.
7. Issues found
- Bug (both files): The first query example runs
SELECT entropy(v) FROM t1but the result table header showsentropy(x). It should beentropy(v). See inline comments. - Bug (English file only): The last output block for
SELECT entropy(NULL) FROM t1uses a ```sql fence instead of ```text. The zh-CN file correctly uses ```text. This causes the output table to render as syntax-highlighted SQL. - Minor (English file): Missing space:
Array, Map,Structshould beArray, Map, Struct. - Suggestion: The multi-expression composite-key behavior described in Parameters has no example. An
entropy(col1, col2)example would help users understand this non-obvious feature.
Versions
Languages
Docs Checklist