Skip to content

docs: fix typos in docs #2279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 20, 2025
Merged

docs: fix typos in docs #2279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/api/composition.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1246,7 +1246,7 @@ function messageCompiler(message, { locale, key, onError }) {
return ctx => formatter.format(ctx.values)
} else {
// If you would like to support it for AST,
// You need to transform locale mesages such as `json`, `yaml`, etc. with the bundle plugin.
// You need to transform locale messages such as `json`, `yaml`, etc. with the bundle plugin.
onError && onError(new Error('not support for AST'))
return () => key // return default with `key`
}
Expand Down Expand Up @@ -1512,7 +1512,7 @@ The use-case for `rt` is for programmatic locale messages translation with using
:::

:::warning
`rt` differs from `t` in that it processes the locale message directly, not the key of the locale message. There is no internal fallback with `rt`. You need to understand and use the structure of the locale messge returned by `tm`.
`rt` differs from `t` in that it processes the locale message directly, not the key of the locale message. There is no internal fallback with `rt`. You need to understand and use the structure of the locale message returned by `tm`.
:::

#### Parameters
Expand Down Expand Up @@ -1548,7 +1548,7 @@ The use-case for `rt` is for programmatic locale messages translation with using
:::

:::warning
`rt` differs from `t` in that it processes the locale message directly, not the key of the locale message. There is no internal fallback with `rt`. You need to understand and use the structure of the locale messge returned by `tm`.
`rt` differs from `t` in that it processes the locale message directly, not the key of the locale message. There is no internal fallback with `rt`. You need to understand and use the structure of the locale message returned by `tm`.
:::

#### Parameters
Expand Down Expand Up @@ -1586,7 +1586,7 @@ The use-case for `rt` is for programmatic locale messages translation with using
:::

:::warning
`rt` differs from `t` in that it processes the locale message directly, not the key of the locale message. There is no internal fallback with `rt`. You need to understand and use the structure of the locale messge returned by `tm`.
`rt` differs from `t` in that it processes the locale message directly, not the key of the locale message. There is no internal fallback with `rt`. You need to understand and use the structure of the locale message returned by `tm`.
:::

#### Parameters
Expand Down Expand Up @@ -1624,7 +1624,7 @@ The use-case for `rt` is for programmatic locale messages translation with using
:::

:::warning
`rt` differs from `t` in that it processes the locale message directly, not the key of the locale message. There is no internal fallback with `rt`. You need to understand and use the structure of the locale messge returned by `tm`.
`rt` differs from `t` in that it processes the locale message directly, not the key of the locale message. There is no internal fallback with `rt`. You need to understand and use the structure of the locale message returned by `tm`.
:::

#### Parameters
Expand Down
8 changes: 4 additions & 4 deletions docs/api/general.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -639,7 +639,7 @@ A fallback locale function implemented with a fallback chain algorithm. It's use

## fallbackWithSimple

Fallback with simple implemenation
Fallback with simple implementation

**Signature:**
```typescript
Expand Down Expand Up @@ -870,21 +870,21 @@ linked(key: Path, modifier?: string, type?: string): MessageType<T>;

A resolve message.

### linked(key, optoins)
### linked(key, options)

Overloaded `linked`

**Signature:**
```typescript
linked(key: Path, optoins?: LinkedOptions): MessageType<T>;
linked(key: Path, options?: LinkedOptions): MessageType<T>;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| key | Path | A message key |
| optoins | LinkedOptions | An [linked options](#linkedoptions) |
| options | LinkedOptions | An [linked options](#linkedoptions) |

#### Returns

Expand Down