Skip to content

Commit e6cc55d

Browse files
[update] italicize parameter type annotations
- change parameter type from backticks to italic in docs: (`string`) -> (*string*) - applied across English source and all 4 locales (de/ko/zh/ru), 126 occurrences in 57 files - parameter names stay in backticks; escaped pipes in union types (e.g. *string \| number*) preserved so tables render - full build verified for all locales, no errors
1 parent a657cbb commit e6cc55d

57 files changed

Lines changed: 126 additions & 126 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/api/sheetmanager_add_method.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ add: (name?: string) => Id;
2424

2525
### Parameters
2626

27-
- `name` - (`string`) optional, the displayed name for the new sheet tab. If omitted, a default name is assigned.
27+
- `name` - (*string*) optional, the displayed name for the new sheet tab. If omitted, a default name is assigned.
2828

2929
### Returns
3030

31-
- `Id` - (`string | number`) the unique identifier of the newly created sheet.
31+
- `Id` - (*string | number*) the unique identifier of the newly created sheet.
3232

3333
### Example
3434

‎docs/api/sheetmanager_clear_method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ clear: (id?: Id) => void;
2020

2121
### Parameters
2222

23-
- `id` - (`string | number`) optional, the unique identifier of the sheet to clear. If omitted, the currently active sheet is cleared.
23+
- `id` - (*string | number*) optional, the unique identifier of the sheet to clear. If omitted, the currently active sheet is cleared.
2424

2525
### Example
2626

‎docs/api/sheetmanager_get_method.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ get: (id: Id) => ISheet;
1818

1919
### Parameters
2020

21-
- `id` - (`string | number`) required, the unique identifier of the sheet to retrieve.
21+
- `id` - (*string | number*) required, the unique identifier of the sheet to retrieve.
2222

2323
### Returns
2424

25-
- `ISheet` - (`object`) the sheet object matching the given id.
25+
- `ISheet` - (*object*) the sheet object matching the given id.
2626

2727
### Example
2828

‎docs/api/sheetmanager_getactive_method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ getActive: () => ISheet;
1818

1919
### Returns
2020

21-
- `ISheet` - (`object`) the currently active sheet object with the `id` and `name` properties.
21+
- `ISheet` - (*object*) the currently active sheet object with the `id` and `name` properties.
2222

2323
### Example
2424

‎docs/api/sheetmanager_getall_method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ getAll: () => ISheet[];
2222

2323
### Returns
2424

25-
- `ISheet[]` - (`array`) an array of sheet objects.
25+
- `ISheet[]` - (*array*) an array of sheet objects.
2626

2727
### Example
2828

‎docs/api/sheetmanager_remove_method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ remove: (id: Id) => void;
2626

2727
### Parameters
2828

29-
- `id` - (`string | number`) required, the unique identifier of the sheet to remove.
29+
- `id` - (*string | number*) required, the unique identifier of the sheet to remove.
3030

3131
### Example
3232

‎docs/api/sheetmanager_setactive_method.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ setActive: (id: Id) => void;
2020

2121
### Parameters
2222

23-
- `id` - (`string | number`) required, the unique identifier of the sheet to activate.
23+
- `id` - (*string | number*) required, the unique identifier of the sheet to activate.
2424

2525
### Example
2626

‎docs/api/spreadsheet_addformula_method.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@ addFormula: (name: string, handler: mathFunction) => void;
2424

2525
### Parameters
2626

27-
- `name` - (`string`) required, the formula name (case-insensitive, stored as uppercase)
28-
- `handler` - (`function`) required, a callback function that processes the input arguments (strings, numbers, booleans, or arrays of these) and returns a single value
27+
- `name` - (*string*) required, the formula name (case-insensitive, stored as uppercase)
28+
- `handler` - (*function*) required, a callback function that processes the input arguments (strings, numbers, booleans, or arrays of these) and returns a single value
2929

3030
:::note
3131
The `handler` callback function must be synchronous. Using `Promise` or `fetch` inside the function is not allowed.

‎docs/customization.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,9 @@ The data collection API of the **toolbar**, **menu**, and **context menu** lets
5757

5858
To add a new control, apply the `spreadsheet.{name}.data.add()` method. It takes the parameters below:
5959

60-
- `config` - (`object`) an object with the control config
61-
- `index` - (`number`) the index of the position to place the control into
62-
- `parent` - (`string`) the id of a parent control (for the `menuItem` type)
60+
- `config` - (*object*) an object with the control config
61+
- `index` - (*number*) the index of the position to place the control into
62+
- `parent` - (*string*) the id of a parent control (for the `menuItem` type)
6363

6464
For a button:
6565

‎docs/number_formatting.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -155,10 +155,10 @@ You are not limited to the [default number formats](#default-number-formats). Yo
155155

156156
You can make all these modifications with the [`formats`](api/spreadsheet_formats_config.md) configuration option. It is an array of format objects, each of which contains a set of properties:
157157

158-
- `id` - (`string`) mandatory, the id of a format used to set a format for a cell with the [`setFormat()`](api/spreadsheet_setformat_method.md) method
159-
- `mask` - (`string`) mandatory, a mask for a number format. Check the list of characters available in a mask [below](#the-structure-of-a-mask)
160-
- `name` - (`string`) optional, the name of a format displayed in the toolbar and menu drop-down lists
161-
- `example` - (`string`) optional, an example that shows what a formatted number looks like
158+
- `id` - (*string*) mandatory, the id of a format used to set a format for a cell with the [`setFormat()`](api/spreadsheet_setformat_method.md) method
159+
- `mask` - (*string*) mandatory, a mask for a number format. Check the list of characters available in a mask [below](#the-structure-of-a-mask)
160+
- `name` - (*string*) optional, the name of a format displayed in the toolbar and menu drop-down lists
161+
- `example` - (*string*) optional, an example that shows what a formatted number looks like
162162

163163
### The structure of a mask
164164

@@ -177,8 +177,8 @@ A mask may contain a set of common syntax characters that include digit placehol
177177

178178
To apply the necessary format to a numeric value, use the [`setFormat()`](api/spreadsheet_setformat_method.md) method. It takes two parameters:
179179

180-
- `cell` - (`string`) the id of the cell whose value should be formatted
181-
- `format` - (`string`) the name of the [default number format](#default-number-formats) to apply to the cell value
180+
- `cell` - (*string*) the id of the cell whose value should be formatted
181+
- `format` - (*string*) the name of the [default number format](#default-number-formats) to apply to the cell value
182182

183183
For example:
184184

0 commit comments

Comments
 (0)