Skip to content

Commit 7d293ba

Browse files
committed
metasheet: improve sentences for clearness
1 parent fb489c1 commit 7d293ba

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

content/en/docs/excel/metasheet.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -478,15 +478,19 @@ It is supposed to generate three different config files (name pattern: `<BookNam
478478

479479
## Option `OrderedMap`
480480

481+
> 📢 It only applies to each level message’s first map field.
482+
481483
If you set `OrderedMap` to `true`, then tableau loader plugins will generate ordered map APIs:
482484

483485
- [C++: OrderedMap API](../../api/loader/cpp/#orderedmap)
484486
- [Go: OrderedMap API](../../api/loader/go/#orderedmap)
485487

486488
## Option `Index`
487489

488-
Option `Index` can be specified to generate index accessers, and multiple indexes are comma-separated.
489-
There are two kinds of indexes in tableau: one is **single-column index**, and another is **multi-column index** (aka composite index).
490+
Option `Index` can be specified to generate index accessers, and multiple
491+
indexes are comma-separated. There are two kinds of indexes in tableau:
492+
one is **single-column index**, and another is **multi-column index**
493+
(aka composite index).
490494

491495
If you set `Index` appropriately, then tableau loader plugins will generate index APIs:
492496

@@ -546,7 +550,11 @@ Example: two worksheets *ItemConf* and *ShopConf* in HelloWorld.xlsx:
546550

547551
Format: `Column<ColumnX,ColumnY,...>@IndexName`.
548552

549-
The sign `@` is the separator between column name and index name. if `IndexName` is not set, it will be this column’s parent struct type name. One or more indexes can be specified by comma-separated rule. The columns in the angle brackets `<>` specify the sorting columns which the index sort by.
553+
The sign `@` is the separator between column name and index name. if
554+
`IndexName` is not set, it will be this column’s parent struct type name.
555+
One or more indexes can be specified by comma-separated rule. The columns in
556+
the angle brackets `<>` specify the sorting columns, which the **result array**
557+
of same index key sort by.
550558

551559
Examples:
552560

@@ -563,7 +571,11 @@ Format: `(Column1,Column2,...)<ColumnX,ColumnY,...>@IndexName`.
563571

564572
Multi-column index (or composite index) is composed of **multiple columns in the same struct** (in list or map) to increase query speed.
565573

566-
The sign `@` is the separator between enclosed column names by parentheses and index name. if `IndexName` is not set, it will be this column’s parent struct type name. One or more indexes can be specified by comma-separated rule. The columns in the angle brackets `<>` specify the sorting columns which the index sort by.
574+
The sign `@` is the separator between enclosed column names by parentheses and
575+
index name. If `IndexName` is not set, it will be this column’s parent struct
576+
type name. One or more indexes can be specified by comma-separated rule. The
577+
columns in the angle brackets `<>` specify the sorting columns, which the
578+
**result array** of same index key sort by.
567579

568580
Examples:
569581

0 commit comments

Comments
 (0)