Skip to content

Commit ac91077

Browse files
committed
docs: update documentation
1 parent b4d7c25 commit ac91077

File tree

2 files changed

+4
-0
lines changed

2 files changed

+4
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,8 @@ WeekEnum.Monday; // 1
245245
WeekEnum.Saturday; // 6
246246
```
247247

248+
> Please note that when creating enums, all enum items must maintain a consistent data structure. For example, you cannot use both Key-Value format and Standard format in the same enum.
249+
>
248250
> You can pass in some optional configuration options to better control the behavior of the enum. Please refer to the [Enum Configuration Options](#-enum-configuration-options) section for details.
249251
250252
## API

README.zh-CN.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -243,6 +243,8 @@ WeekEnum.Monday; // 1
243243
WeekEnum.Saturday; // 6
244244
```
245245

246+
> 请注意:当创建枚举对象时,所有枚举项的数据结构必须保持一致。例如,不能在同一个枚举中同时使用 Key-Value 格式和标准格式。
247+
>
246248
> 枚举还支持一些配置项,以更好地控制枚举的行为,详情请参考 [枚举配置选项](#-枚举配置选项) 章节。
247249
248250
## API

0 commit comments

Comments
 (0)