Skip to content

docs(table-design): clarity pass on Index Overview scenario prose#3942

Merged
dataroaring merged 1 commit into
apache:masterfrom
dataroaring:docs-index-prose-clarity
Jun 18, 2026
Merged

docs(table-design): clarity pass on Index Overview scenario prose#3942
dataroaring merged 1 commit into
apache:masterfrom
dataroaring:docs-index-prose-clarity

Conversation

@dataroaring

Copy link
Copy Markdown
Contributor

What

A focused readability pass on the index mechanism descriptions in Index Overview > "How Each Index Works" (Scenarios 1-2): the prefix / inverted / ZoneMap / BloomFilter / NGram explanations.

  • Split long run-on sentences into short declarative ones.
  • Active voice with Doris as the subject (e.g. "Doris builds an inverted table…" instead of passive constructions).
  • Remove the marketing word "more powerful" ("replaced by the more powerful inverted index" → "replaced by the inverted index").

No technical meaning changed. Reference tables (comparison, operators) and the capability lists in Scenarios 3-4 are left as-is, since terse reference content is appropriate there.

Scope

Why

This content reads as dense, translated-from-source prose (60+ word single sentences, marketing adjective). The rest of the page was made task-first in #3941; this brings the explanation prose to the same clarity bar.

Databricks-style rewrite of the index mechanism descriptions in 'How Each Index
Works' (Scenarios 1-2): shorter sentences, active voice with Doris as the
subject, and remove the marketing word 'more powerful'. Reference tables and
capability lists left as-is. EN + zh-CN; does not touch the Start Here section
(separate PR apache#3941).
@dataroaring dataroaring merged commit f5f8f0e into apache:master Jun 18, 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.

1 participant