docs: remove Optional/Required comments (#181)

* docs: fix typo * docs: remove `Optional/Required` comments --------- Co-authored-by: shileili.lsl <[email protected]>
ant-design · Dec 7, 2023 · 87866e4 · 87866e4
1 parent 1248253
commit 87866e4
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 23 deletions.
diff --git a/packages/web3/src/browser-link/index.md b/packages/web3/src/browser-link/index.md
@@ -5,7 +5,7 @@ group: Display
 
 # BrowserLink
 
-a quick way to use etherscan adress.
+a quick way to use etherscan address.
 
 ## Basic Usage
 
@@ -23,11 +23,11 @@ a quick way to use etherscan adress.
 
 | Property | Description | Type | Default | Version |
 | --- | --- | --- | --- | --- |
-| `icon` | Optional. Icon property, can be a boolean value or a custom React node. | `boolean \| React.ReactNode` | - | - |
-| `iconOnly` | Optional. Whether to display only the icon. | `boolean` | `false` | - |
-| `ellipsis` | Optional. Whether to enable ellipsis for displaying Ethereum addresses. | `boolean` | - | - |
-| `address` | Required. Ethereum address to generate the link. | `string` | - | - |
-| `href` | Optional. Custom link target. If provided, it will override the generated link. | `string` | - | - |
-| `type` | Optional. The type of link, either 'address' (default) or 'transaction'. | `address \| transaction` | `address` | - |
-| `chain` | Optional. Ethereum chain identifier. Defaults to the mainnet. | `ChainIds` | `ChainIds.Mainnet` | - |
-| `name` | Optional. Custom display name. Display `address` default. | `string` | - | - |
+| `icon` | Icon property, can be a boolean value or a custom React node. | `boolean \| React.ReactNode` | - | - |
+| `iconOnly` | Whether to display only the icon. | `boolean` | `false` | - |
+| `ellipsis` | Whether to enable ellipsis for displaying Ethereum addresses. | `boolean` | - | - |
+| `address` | Ethereum address to generate the link. | `string` | - | - |
+| `href` | Custom link target. If provided, it will override the generated link. | `string` | - | - |
+| `type` | The type of link, either 'address' (default) or 'transaction'. | `address \| transaction` | `address` | - |
+| `chain` | Ethereum chain identifier. Defaults to the mainnet. | `ChainIds` | `ChainIds.Mainnet` | - |
+| `name` | Custom display name. Display `address` default. | `string` | - | - |
diff --git a/packages/web3/src/browser-link/index.zh-CN.md b/packages/web3/src/browser-link/index.zh-CN.md
@@ -23,11 +23,11 @@ group: 展示
 
 | 属性 | 描述 | 类型 | 默认值 | 版本 |
 | --- | --- | --- | --- | --- |
-| `icon` | 可选。图标属性，可以是布尔值或自定义 React 节点。 | `boolean \| React.ReactNode` | - | - |
-| `iconOnly` | 可选。是否只显示图标。 | `boolean` | `false` | - |
-| `ellipsis` | 可选。是否启用省略号来显示以太坊地址。 | `boolean` | - | - |
-| `address` | 必需。要生成链接的以太坊地址。 | `string` | - | - |
-| `href` | 可选。自定义链接目标。如果提供，将覆盖生成的链接。 | `string` | - | - |
-| `type` | 可选。链接类型，是 'address'（默认）还是 'transaction'。 | `address \| transaction` | `address` | - |
-| `chain` | 可选。以太坊链标识符。默认为主网。 | `ChainIds` | `ChainIds.Mainnet` | - |
-| `name` | 可选。自定义显示名称。不传默认显示 `address` | `string` | - | - |
+| `icon` | 图标属性，可以是布尔值或自定义 React 节点。 | `boolean \| React.ReactNode` | - | - |
+| `iconOnly` | 是否只显示图标。 | `boolean` | `false` | - |
+| `ellipsis` | 是否启用省略号来显示以太坊地址。 | `boolean` | - | - |
+| `address` | 要生成链接的以太坊地址。 | `string` | - | - |
+| `href` | 自定义链接目标。如果提供，将覆盖生成的链接。 | `string` | - | - |
+| `type` | 链接类型，是 'address'（默认）还是 'transaction'。 | `address \| transaction` | `address` | - |
+| `chain` | 以太坊链标识符。默认为主网。 | `ChainIds` | `ChainIds.Mainnet` | - |
+| `name` | 自定义显示名称。不传默认显示 `address` | `string` | - | - |
diff --git a/packages/web3/src/nft-image/index.md b/packages/web3/src/nft-image/index.md
@@ -23,8 +23,8 @@ Components used to display NFT images more conveniently and simply.
 
 | Property | Description | Type | Default | Version |
 | --- | --- | --- | --- | --- |
-| address | Required. NFT contract address. | `string` | - | - |
-| tokenId | Required. NFT token ID, which can be of type bigint or number. | `bigint \| number` | - | - |
-| getNFTMetadata | Optional. Custom method to get NFT metadata. | `(address: string, tokenId: bigint \| number) => Promise<NFTMetadata>` | - | - |
+| address | NFT contract address. | `string` | - | - |
+| tokenId | NFT token ID, which can be of type bigint or number. | `bigint \| number` | - | - |
+| getNFTMetadata | Custom method to get NFT metadata. | `(address: string, tokenId: bigint \| number) => Promise<NFTMetadata>` | - | - |
 
 Other properties inherited from the [Ant Design Image](https://ant-design.antgroup.com/components/image) component.
diff --git a/packages/web3/src/nft-image/index.zh-CN.md b/packages/web3/src/nft-image/index.zh-CN.md
@@ -23,8 +23,8 @@ group: 展示
 
 | 属性 | 描述 | 类型 | 默认值 | 版本 |
 | --- | --- | --- | --- | --- |
-| address | 必需。NFT 合约地址。 | `string` | - | - |
-| tokenId | 必需。NFT 令牌 ID，可以是 bigint 或 number 类型。 | `bigint \| number` | - | - |
-| getNFTMetadata | 可选。自定义获取 NFT 元数据的方法。 | `(address: string, tokenId: bigint \| number) => Promise<NFTMetadata>` | - | - |
+| address | NFT 合约地址。 | `string` | - | - |
+| tokenId | NFT 令牌 ID，可以是 bigint 或 number 类型。 | `bigint \| number` | - | - |
+| getNFTMetadata | 自定义获取 NFT 元数据的方法。 | `(address: string, tokenId: bigint \| number) => Promise<NFTMetadata>` | - | - |
 
 其他属性继承自[Ant Design Image](https://ant-design.antgroup.com/components/image-cn)