[fix] correct typos / wrong descriptions / stray markdown in SQL data-type and aggregate-function docs#3705
Merged
Conversation
…-type and aggregate-function docs Batch fix for 10 issues found in a documentation audit (audit findings apache#201–apache#214, "simple" tier): - STRING.md: drop the spurious "STRING (M)" — the STRING type does not take a length parameter (both in frontmatter description and body) - variables.md: version_comment row had inconsistent Value vs Default_Value formats (`doris0.0.0--de61c5823` vs `doris-0.0--de61c5823`); normalized to the canonical `doris-0.0.0--de61c58223` form used by the zh-CN copies - ai-agg.md: typo `default_ai_resoure` -> `default_ai_resource` - array-agg.md: remove a stray table row that sat OUTSIDE the closing code fence - bitmap-intersect.md: collapse two consecutive `## Example` headings into one - bool-or.md: Return Value said "TRUE when all non-NULL values exist" (wrong for OR); fixed to "TRUE when at least one non-NULL value is TRUE" - covar-samp.md: remove an orphan duplicated result block + extra closing fence - histogram.md: bucket field descriptions had `lower: Upper bound` / `upper: Lower bound` swapped; corrected - JSON.md: two consecutive bullets both started with `CAST(string AS JSON):` — merged into one bullet - percentile_reservoir.md: third example's query and result header used `percentile(...)` instead of `percentile_reservoir(...)` (copy-paste artifact from percentile.md) Scope: docs/ + versioned_docs/version-{2.1,3.x,4.x}/ as applicable per file. No changes to legacy version-1.2 / version-2.0 trees or to ja-source/. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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 ten small documentation issues across
sql-manual/basic-element/andsql-manual/sql-functions/aggregate-functions/. Each item below is independent.STRING (M)from the type description (both the frontmatter description and the body). STRING does not take a length parameter.version_commentrow showed different values in the Value vs Default_Value columns (doris0.0.0--de61c5823vsdoris-0.0--de61c5823). Both columns now use the canonicaldoris-0.0.0--de61c58223form already used in the zh-CN translation.default_ai_resoure→default_ai_resource.| 1 | ["a","b"] |table row that sat outside the closing code fence and rendered as literal text.## Exampleheadings into one.lowerandupperbucket field descriptions were swapped (lower: Upper bound,upper: Lower bound). Corrected.CAST(string AS JSON):. Merged into one bullet that keeps the content of both.percentile(...)instead ofpercentile_reservoir(...)(looked like copy-paste frompercentile.md).Test plan
version_commentrow, single## Examplein bitmap-intersect, clean result tables in array-agg / covar-samp, corrected bucket field descriptions in histogram, merged bullet in JSON.md,percentile_reservoirin the third example)