Skip to content

[fix] correct typos / wrong descriptions / stray markdown in SQL data-type and aggregate-function docs#3705

Merged
morningman merged 1 commit into
apache:masterfrom
boluor:fix-batch13-14-simple
May 20, 2026
Merged

[fix] correct typos / wrong descriptions / stray markdown in SQL data-type and aggregate-function docs#3705
morningman merged 1 commit into
apache:masterfrom
boluor:fix-batch13-14-simple

Conversation

@boluor
Copy link
Copy Markdown
Contributor

@boluor boluor commented May 20, 2026

Summary

Fixes ten small documentation issues across sql-manual/basic-element/ and sql-manual/sql-functions/aggregate-functions/. Each item below is independent.

  • STRING.md — drop the spurious STRING (M) from the type description (both the frontmatter description and the body). STRING does not take a length parameter.
  • variables.md — the version_comment row showed different values in the Value vs Default_Value columns (doris0.0.0--de61c5823 vs doris-0.0--de61c5823). Both columns now use the canonical doris-0.0.0--de61c58223 form already used in the zh-CN translation.
  • ai-agg.md — typo default_ai_resouredefault_ai_resource.
  • array-agg.md — remove a stray | 1 | ["a","b"] | table row that sat outside the closing code fence and rendered as literal text.
  • bitmap-intersect.md — collapse two consecutive ## Example headings into one.
  • bool-or.md — the Return Value paragraph said "TRUE when all non-NULL values exist", which is the logical AND semantics. Corrected to "TRUE when at least one non-NULL value is TRUE".
  • covar-samp.md — remove an orphan duplicated result-table block plus an extra closing code fence that appeared after the legitimate one.
  • histogram.md — the lower and upper bucket field descriptions were swapped (lower: Upper bound, upper: Lower bound). Corrected.
  • JSON.md — two consecutive bullets both began with CAST(string AS JSON):. Merged into one bullet that keeps the content of both.
  • percentile_reservoir.md — the third example's query and result header used percentile(...) instead of percentile_reservoir(...) (looked like copy-paste from percentile.md).

Test plan

  • CI doc build passes
  • Spot-check the affected pages render as expected (STRING.md description, variables.md version_comment row, single ## Example in bitmap-intersect, clean result tables in array-agg / covar-samp, corrected bucket field descriptions in histogram, merged bullet in JSON.md, percentile_reservoir in the third example)

…-type and aggregate-function docs

Batch fix for 10 issues found in a documentation audit (audit findings apache#201apache#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>
@morningman morningman merged commit 28557d6 into apache:master May 20, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants