format docs

irisnet · Sep 30, 2019 · ad988fd · ad988fd
1 parent 351e275
commit ad988fd
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 32 deletions.
diff --git a/docs/zh/cli-client/asset.md b/docs/zh/cli-client/asset.md
@@ -29,7 +29,7 @@ iriscli asset create-gateway <flags>
 
 **唯一标识：**
 
-| 名称, 速记 | 类型   | 是否必须 | 默认 | 描述                                                   |
+| 名称, 速记 | 类型   | 必须 | 默认 | 描述                                                   |
 | ---------- | ------ | -------- | ---- | ------------------------------------------------------ |
 | --moniker  | string | 是       |      | 唯一名称，大小在3到8之间，以字母开头，后跟字母数字字符 |
 | --identity | string |          |      | 可选，身份签名，最大长度为128（例如UPort或Keybase）    |
@@ -52,7 +52,7 @@ iriscli asset edit-gateway <flags>
 
 **唯一标识：**
 
-| 名称, 速记 | 类型   | 是否必须 | 默认 | 描述                                                 |
+| 名称, 速记 | 类型   | 必须 | 默认 | 描述                                                 |
 | ---------- | ------ | -------- | ---- | ---------------------------------------------------- |
 | --moniker  | string | 是       |      | 唯一，别名，大小在3到8之间，以字母开头，后跟字母数字 |
 | --identity | string |          |      | 可选，身份签名，最大长度为128                        |
@@ -75,7 +75,7 @@ iriscli asset transfer-gateway-owner <flags>
 
 **唯一标识：**
 
-| 名称, 速记 | 类型    | 是否必须 | 默认 | 描述                 |
+| 名称, 速记 | 类型    | 必须 | 默认 | 描述                 |
 | ---------- | ------- | -------- | ---- | -------------------- |
 | --moniker  | string  | 是       |      | 被转让网关的唯一别名 |
 | --to       | Address | 是       |      | 转让网关的接收者     |
@@ -96,7 +96,7 @@ iriscli asset issue-token <flags>
 
 **唯一标识：**
 
-| 名称, 速记         | 类型    | 是否必须 | 默认          | 描述                                                         |
+| 名称, 速记         | 类型    | 必须 | 默认          | 描述                                                         |
 | ------------------ | ------- | -------- | ------------- | ------------------------------------------------------------ |
 | --family           | string  | 是       | fungible      | 通证类型: fungible, non-fungible (不支持)                    |
 | --source           | string  |          | native        | 通证来源: native, gateway                                    |
@@ -158,7 +158,7 @@ iriscli asset edit-token <token-id> <flags>
 
 **唯一标识：**
 
-| 名称, 速记         | 类型   | 是否必须 | 默认  | 描述                          |
+| 名称, 速记         | 类型   | 必须 | 默认  | 描述                          |
 | ------------------ | ------ | -------- | ----- | ----------------------------- |
 | --name             | string |          |       | 通证名称，例如：IRIS Network  |
 | --canonical-symbol | string |          |       | 网关或外部通证的源符号        |
@@ -184,7 +184,7 @@ iriscli asset transfer-token-owner <token-id> <flags>
 
 **唯一标识：**
 
-| 名称, 速记 | 类型   | 是否必须 | 默认 | 描述       |
+| 名称, 速记 | 类型   | 必须 | 默认 | 描述       |
 | ---------- | ------ | -------- | ---- | ---------- |
 | --to       | string | 是       |      | 接收人地址 |
 
@@ -204,7 +204,7 @@ iriscli asset mint-token <token-id> <flags>
 
 **唯一标识：**
 
-| 名称, 速记 | 类型   | 是否必须 | 默认 | 描述                               |
+| 名称, 速记 | 类型   | 必须 | 默认 | 描述                               |
 | ---------- | ------ | -------- | ---- | ---------------------------------- |
 | --to       | string |          |      | 增发通证的地址，默认为您自己的地址 |
 | --amount   | uint64 | 是       | 0    | 增发的金额                         |
@@ -259,7 +259,7 @@ iriscli asset query-tokens <flags>
 
 **唯一标识：**
 
-| 名称, 速记 | 类型   | 是否必须 | 默认 | 描述                                        |
+| 名称, 速记 | 类型   | 必须 | 默认 | 描述                                        |
 | ---------- | ------ | -------- | ---- | ------------------------------------------- |
 | --source   | string |          |      | 枚举值: native / gateway / external         |
 | --gateway  | string |          |      | 网关的唯一名称，当`source`是`gateway`时需要 |
@@ -312,7 +312,7 @@ iriscli asset query-gateway <flags>
 
 **唯一标识：**
 
-| 名称, 速记 | 类型   | 是否必须 | 默认 | 描述                                               |
+| 名称, 速记 | 类型   | 必须 | 默认 | 描述                                               |
 | ---------- | ------ | -------- | ---- | -------------------------------------------------- |
 | --moniker  | string | 是       |      | 唯一名称，大小在3到8之间，以字母开头，后跟字母数字 |
 
@@ -332,7 +332,7 @@ iriscli asset query-gateways <flags>
 
 **唯一标识：**
 
-| 名称, 速记 | 类型    | 是否必须 | 默认 | 描述               |
+| 名称, 速记 | 类型    | 必须 | 默认 | 描述               |
 | ---------- | ------- | -------- | ---- | ------------------ |
 | --owner    | Address |          |      | 要查询的所有者地址 |
 
@@ -352,7 +352,7 @@ iriscli asset query-fee <flags>
 
 **唯一标识：**
 
-| 名称, 速记 | 类型   | 是否必须 | 默认 | 描述                                           |
+| 名称, 速记 | 类型   | 必须 | 默认 | 描述                                           |
 | ---------- | ------ | -------- | ---- | ---------------------------------------------- |
 | --gateway  | string |          |      | 网关名称，用于查询网关费用                     |
 | --token    | string |          |      | 通证ID，用于查询通证费用 |

diff --git a/docs/zh/cli-client/bank.md b/docs/zh/cli-client/bank.md
@@ -43,7 +43,7 @@ ERROR: {"codespace":"sdk","code":9,"message":"account iaa1kenrwk5k4ng70e5s9zfstt
 
 **唯一标识：**
 
-| 名称, 速记   | 类型   | 是否必须 | 默认                  | 描述                                  |
+| 名称, 速记   | 类型   | 必须 | 默认                  | 描述                                  |
 | ------------ | ------ | -------- | --------------------- | ------------------------------------- |
 | -h, --help   |        |          |                       | `coin-type`子命令的提示信息           |
 | --chain-id   | string |          |                       | tendermint节点的Chain ID              |
@@ -80,7 +80,7 @@ CoinType:
 
 **唯一标识：**
 
-| 名称, 速记   | 类型   | 是否必须 | 默认                  | 描述                                 |
+| 名称, 速记   | 类型   | 必须 | 默认                  | 描述                                 |
 | ------------ | ------ | -------- | --------------------- | ------------------------------------ |
 | -h, --help   |        |          |                       | `token-stats`子命令的提示信息        |
 | --chain-id   | string |          |                       | tendermint节点的Chain ID             |
@@ -116,7 +116,7 @@ iriscli bank account <address> <flags>
 
 **唯一标识：**
 
-| 名称, 速记   | 类型   | 是否必须 | 默认                  | 描述                                 |
+| 名称, 速记   | 类型   | 必须 | 默认                  | 描述                                 |
 | ------------ | ------ | -------- | --------------------- | ------------------------------------ |
 | -h, --help   |        |          |                       | `account`子命令的提示信息            |
 | --chain-id   | string |          |                       | tendermint节点的Chain ID             |
@@ -153,7 +153,7 @@ iriscli bank send --from=<key-name> --to=<address> --amount=<amount> --fee=<nati
 
 **唯一标识：**
 
-| 名称, 速记 | 类型   | 是否必须 | 默认 | 描述                           |
+| 名称, 速记 | 类型   | 必须 | 默认 | 描述                           |
 | ---------- | ------ | -------- | ---- | ------------------------------ |
 | --amount   | string | Yes      |      | 要发送的通证数量，例如：10iris |
 | --to       | string |          |      | 接收通证的Bech32编码地址       |
@@ -174,7 +174,7 @@ iriscli bank burn --from=<key-name> --amount=<amount-to-burn> --fee=<native-fee>
 
 **唯一标识：**
 
-| 名称, 速记 | 类型   | 是否必须 | 默认 | 描述                         |
+| 名称, 速记 | 类型   | 必须 | 默认 | 描述                         |
 | ---------- | ------ | -------- | ---- | ---------------------------- |
 | --amount   | string | Yes      |      | 要销毁的通证数量，例如10iris |
 
@@ -194,7 +194,7 @@ iriscli bank set-memo-regexp --regexp=<regular-expression> --from=<key-name> --f
 
 **唯一标识：**
 
-| 名称, 速记 | 类型   | 是否必须 | 默认 | 描述                                          |
+| 名称, 速记 | 类型   | 必须 | 默认 | 描述                                          |
 | ---------- | ------ | -------- | ---- | --------------------------------------------- |
 | --regexp   | string | Yes      |      | 正则表达式，最大长度为50，例如^[A-ZA-Z0-9]+ $ |
 

diff --git a/docs/zh/cli-client/distribution.md b/docs/zh/cli-client/distribution.md
@@ -76,7 +76,7 @@ iriscli distribution withdraw-rewards <flags>
 
 **唯一标识：**
 
-| 名称, 速记       | 类型   | 是否必须 | 默认 | 描述                                         |
+| 名称, 速记       | 类型   | 必须 | 默认 | 描述                                         |
 | --------------------- | ------ | -------- | ------- | --------------------------------------------------- |
 | --only-from-validator | string |          |         | 仅从此验证者地址中提取（以bech格式） |
 | --is-validator        | bool   |          | false   | 同时取回验证人的佣金                |

diff --git a/docs/zh/cli-client/gov.md b/docs/zh/cli-client/gov.md
@@ -27,7 +27,7 @@ iriscli gov query-proposal <flags>
 
 **唯一标识：**
 
-| 名称, 速记    | 类型 | 是否必须 | 默认 | 描述     |
+| 名称, 速记    | 类型 | 必须 | 默认 | 描述     |
 | ------------- | ---- | -------- | ---- | -------- |
 | --proposal-id | uint | 是       |      | 提案的Id |
 
@@ -47,7 +47,7 @@ iriscli gov query-proposals <flags>
 
 **唯一标识：**
 
-| 名称, 速记  | 类型    | 是否必须 | 默认 | 描述                                  |
+| 名称, 速记  | 类型    | 必须 | 默认 | 描述                                  |
 | ----------- | ------- | -------- | ---- | ------------------------------------- |
 | --depositor | Address |          |      | 按抵押人地址过滤提案                  |
 | --limit     | uint    |          |      | 限制返回提案的个数， 默认返回所有提案 |
@@ -76,7 +76,7 @@ iriscli gov query-vote <flags>
 
 **唯一标识：**
 
-| 名称, 速记    | 类型    | 是否必须 | 默认 | 描述       |
+| 名称, 速记    | 类型    | 必须 | 默认 | 描述       |
 | ------------- | ------- | -------- | ---- | ---------- |
 | --proposal-id | uint    | 是       |      | 提案的Id   |
 | --voter       | Address | 是       |      | 投票人地址 |
@@ -97,7 +97,7 @@ iriscli gov query-votes <flags>
 
 **唯一标识：**
 
-| 名称, 速记    | 类型 | 是否必须 | 默认 | 描述     |
+| 名称, 速记    | 类型 | 必须 | 默认 | 描述     |
 | ------------- | ---- | -------- | ---- | -------- |
 | --proposal-id | uint | 是       |      | 提案的Id |
 
@@ -117,7 +117,7 @@ iriscli gov query-deposit <flags>
 
 **唯一标识：**
 
-| 名称, 速记    | 类型    | 是否必须 | 默认 | 描述       |
+| 名称, 速记    | 类型    | 必须 | 默认 | 描述       |
 | ------------- | ------- | -------- | ---- | ---------- |
 | --proposal-id | uint    | 是       |      | 提案的Id   |
 | --depositor   | Address | 是       |      | 抵押人地址 |
@@ -138,7 +138,7 @@ iriscli gov query-deposits <flags>
 
 **唯一标识：**
 
-| 名称, 速记    | 类型 | 是否必须 | 默认 | 描述     |
+| 名称, 速记    | 类型 | 必须 | 默认 | 描述     |
 | ------------- | ---- | -------- | ---- | -------- |
 | --proposal-id | uint | 是       |      | 提案的Id |
 
@@ -158,7 +158,7 @@ iriscli gov query-tally <flags>
 
 **唯一标识：**
 
-| 名称, 速记    | 类型 | 是否必须 | 默认 | 描述     |
+| 名称, 速记    | 类型 | 必须 | 默认 | 描述     |
 | ------------- | ---- | -------- | ---- | -------- |
 | --proposal-id |  uint    | 是       |      | 提案的Id |
 
@@ -178,7 +178,7 @@ iriscli gov submit-proposal <flags>
 
 **唯一标识：**
 
-| 名称, 速记               | 类型   | 是否必须 | 默认  | 描述                                                                                           |
+| 名称, 速记               | 类型   | 必须 | 默认  | 描述                                                                                           |
 | ------------------------ | ------ | -------- | ----- | ---------------------------------------------------------------------------------------------- |
 | --deposit                | Coin   | 是       |       | 初始抵押金额(至少最小抵押金额的30% of)                                                         |
 | --description            | string | 是       |       | 提案的描述信息                                                                                 |
@@ -242,7 +242,7 @@ iriscli gov deposit <flags>
 
 **唯一标识：**
 
-| 名称, 速记    | 类型 | 是否必须 | 默认 | 描述           |
+| 名称, 速记    | 类型 | 必须 | 默认 | 描述           |
 | ------------- | ---- | -------- | ---- | -------------- |
 | --deposit     | Coin | 是       |      | 抵押的通证金额 |
 | --proposal-id | uint | 是       |      | 提案Id         |
@@ -269,7 +269,7 @@ iriscli gov vote <flags>
 
 **唯一标识：**
 
-| 名称, 速记    | 类型   | 是否必须 | 默认 | 描述                            |
+| 名称, 速记    | 类型   | 必须 | 默认 | 描述                            |
 | ------------- | ------ | -------- | ---- | ------------------------------- |
 | --option      | string | 是       |      | 选项：Yes/No/NoWithVeto/Abstain |
 | --proposal-id | uint   | 是       |      | 提案Id                          |
diff --git a/docs/zh/cli-client/htlc.md b/docs/zh/cli-client/htlc.md
@@ -13,7 +13,7 @@ HTLC allows you to manage local Hash Time Locked Contracts (HTLCs) for atomic sw
 
 ## 全局标识
 
-| 名称, 速记     | 类型   | 是否必须 | 默认           | 描述                           |
+| 名称, 速记     | 类型   | 必须 | 默认           | 描述                           |
 | -------------- | ------ | -------- | -------------- | ------------------------------ |
 | -h, --help     |        |          |                | 提示                           |
 | -e, --encoding | string |          | hex            | 字符串二进制编码 (hex\b64\btc) |
@@ -31,7 +31,7 @@ iriscli htlc create --receiver=<receiver> --receiver-on-other-chain=<receiver-on
 
 **唯一标识：**
 
-| 名称, 速记                | 类型     | 是否必须 | 默认 | 描述                                              |
+| 名称, 速记                | 类型     | 必须 | 默认 | 描述                                              |
 | ------------------------- | -------- | -------- | ---- | ------------------------------------------------- |
 | --receiver                | string   | 是       |      | 收款人地址                                        |
 | --receiver-on-other-chain | bytesHex | 是       |      | 另一条链上的收款地址                              |
@@ -66,7 +66,7 @@ iriscli htlc claim --hash-lock=<hash-lock> --secret=<secret>
 
 **唯一标识：**
 
-| 名称, 速记  | 类型     | 是否必须 | 默认 | 描述                              |
+| 名称, 速记  | 类型     | 必须 | 默认 | 描述                              |
 | ----------- | -------- | -------- | ---- | --------------------------------- |
 | --hash-lock | bytesHex | 是       |      | T要发送锁定资金 HTLC 的 hash lock |
 | --secret    | bytesHex | 是       |      | 用于生成 hash lock 的 secret      |
@@ -93,7 +93,7 @@ iriscli htlc refund --hash-lock=<hash-lock>
 
 **唯一标识：**
 
-| 名称, 速记  | 类型     | 是否必须 | 默认 | 描述                       |
+| 名称, 速记  | 类型     | 必须 | 默认 | 描述                       |
 | ----------- | -------- | -------- | ---- | -------------------------- |
 | --hash-lock | bytesHex | 是       |      | 要退款的 HTLC 的 hash Lock |