Merge pull request #637 from HaoyangLiu/haoyang/docs

Refactor docs for stake query interface

docs/cli-client/distribution/README.md

@@ -6,13 +6,13 @@ This document describes how to use the the command line interfaces of distributi
 
 ## Usage
 
-```shell
+```
 iriscli distribution [subcommand] [flags]
 ```
 
 Print all supported subcommands and flags:
 
-```shell
+```
 iriscli distribution --help
 ```
 

docs/cli-client/distribution/delegator-distr-info.md

@@ -7,22 +7,18 @@ Query a delegator distribution information
 ## Usage
 
 ```
-iriscli distribution delegator-distr-info [flags]
+iriscli distribution delegator-distr-info [delegator address] [flags]
 ```
 
 Print help messages:
 ```
 iriscli distribution delegator-distr-info --help
 ```
 
-## Unique Flags
-
-There is no unique flag. But it requires a argument: delegator address
-
 ## Examples
 
 ```
-iriscli distribution delegator-distr-info <delegator address> 
+iriscli distribution delegator-distr-info [delegator address] 
 ```
 Example response:
 ```json

docs/cli-client/distribution/set-withdraw-address.md

@@ -7,21 +7,17 @@ Set withdraw address for delegator
 ## Usage
 
 ```
-iriscli distribution set-withdraw-addr [withdraw-addr] [flags]
+iriscli distribution set-withdraw-addr [withdraw-address] [flags]
 ```
 
 Print help messages:
 ```
 iriscli distribution set-withdraw-addr --help
 ```
 
-## Unique Flags
-
-There is no unique flag. But it requires an argument: new withdraw address
-
 
 ## Examples
 
 ```
-iriscli distribution set-withdraw-addr <withdraw address> --from <key name> --fee=0.004iris --chain-id=<chain-id>
+iriscli distribution set-withdraw-addr [withdraw address] --from <key name> --fee=0.004iris --chain-id=<chain-id>
 ```

docs/cli-client/distribution/validator-distr-info.md

@@ -7,23 +7,18 @@ Query a validator distribution information
 ## Usage
 
 ```
-iriscli distribution validator-distr-info [flags]
+iriscli distribution validator-distr-info [validator address] [flags]
 ```
 
 Print help messages:
 ```
 iriscli distribution validator-distr-info --help
 ```
 
-## Unique Flags
-
-There is no unique flag. But it requires an argument: validator address
-
-
 ## Examples
 
 ```
-iriscli distribution validator-distr-info <validator address>
+iriscli distribution validator-distr-info [validator address]
 ```
 Example response:
 ```json

docs/cli-client/distribution/withdraw-address.md

@@ -5,7 +5,6 @@
 Query the withdraw address of a delegator
 
 ## Usage
-
 ```
 iriscli distribution withdraw-address [delegator address] [flags]
 ```
@@ -16,15 +15,10 @@ Print help messages:
 iriscli distribution withdraw-address --help
 ```
 
-## Unique Flags
-
-There is no unique option. But it requires a argument: delegator address
-
-
 ## Examples
 
 ```
-iriscli distribution withdraw-address
+iriscli distribution withdraw-address [delegator address]
 ```
 Example response:
 ```text

docs/cli-client/distribution/withdraw-rewards.md

@@ -12,7 +12,7 @@ iriscli distribution withdraw-rewards [flags]
 
 Print help messages:
 
-```shell
+```
 iriscli distribution withdraw-rewards --help
 ```
 

docs/cli-client/stake/README.md

@@ -6,12 +6,12 @@ Stake module provides a set of subcommands to query staking state and send staki
 
 ## Usage
 
-```shell
+```
 iriscli stake [subcommand] [flags]
 ```
 
 Print all supported subcommands and flags:
-```shell
+```
 iriscli stake --help
 ```
 

docs/cli-client/stake/create-validator.md

@@ -11,7 +11,7 @@ iriscli stake create-validator [flags]
 ```
 
 Print help messages:
-```shell
+```
 iriscli stake create-validator --help
 ```
 
@@ -33,7 +33,7 @@ iriscli stake create-validator --help
 
 ## Examples
 
-```shell
+```
 iriscli stake create-validator --chain-id=<chain-id> --from=<key name> --fee=0.004iris --pubkey=<Validator PubKey> --commission-max-change-rate=0.01 --commission-max-rate=0.2 --commission-rate=0.1 --amount=100iris --moniker=<validator name>
 ```
 

docs/cli-client/stake/delegate.md

@@ -11,7 +11,7 @@ iriscli stake delegate [flags]
 ```
 
 Print help messages:
-```shell
+```
 iriscli stake delegate --help
 ```
 
@@ -24,6 +24,6 @@ iriscli stake delegate --help
 
 ## Examples
 
-```shell
+```
 iriscli stake delegate --chain-id=<chain-id> --from=<key name> --fee=0.004iris --amount=100iris --address-validator=<ValidatorAddress>
 ```

docs/cli-client/stake/delegation.md

@@ -9,26 +9,22 @@ Query a delegation based on address and validator address
 ```
 iriscli stake delegation [flags]
 ```
+Print help messages:
+```
+iriscli stake delegation --help
+```
 
-## Flags
+## Unique Flags
 
 | Name, shorthand       | Default                    | Description                                                          | Required |
 | --------------------- | -------------------------- | -------------------------------------------------------------------- | -------- |
 | --address-delegator   |                            | [string] Bech address of the delegator                               | Yes      |
 | --address-validator   |                            | [string] Bech address of the validator                               | Yes      |
-| --chain-id            |                            | [string] Chain ID of tendermint node                                 |          |
-| --height              | most recent provable block | block height to query                                                |          |
-| --help, -h            |                            | help for delegation                                                   |          |
-| --indent              |                            | Add indent to JSON response                                          |          |
-| --ledger              |                            | Use a connected Ledger device                                        |          |
-| --node                | tcp://localhost:26657      | [string] \<host>:\<port> to tendermint rpc interface for this chain  |          |
-| --trust-node          | true                       | Don't verify proofs for responses                                    |          |
 
 ## Examples
 
-### Query a validator
-
-```shell
+Query a validator
+```
 iriscli stake delegation --address-validator=ValidatorAddress --address-delegator=DelegatorAddress
 
 ```

docs/cli-client/stake/delegations.md

@@ -7,27 +7,18 @@ Query all delegations made from one delegator
 ## Usage
 
 ```
-iriscli stake delegations [delegator-addr] [flags]
+iriscli stake delegations [delegator-address] [flags]
+```
+Print help messages:
+```
+iriscli stake delegations --help
 ```
-
-## Flags
-
-| Name, shorthand       | Default                    | Description                                                          | Required |
-| --------------------- | -------------------------- | -------------------------------------------------------------------- | -------- |
-| --chain-id            |                            | [string] Chain ID of tendermint node                                 |          |
-| --height              | most recent provable block | block height to query                                                |          |
-| --help, -h            |                            | help for delegations                                                 |          |
-| --indent              |                            | Add indent to JSON response                                          |          |
-| --ledger              |                            | Use a connected Ledger device                                        |          |
-| --node                | tcp://localhost:26657      | [string] \<host>:\<port> to tendermint rpc interface for this chain  |          |
-| --trust-node          | true                       | Don't verify proofs for responses                                    |          |
 
 ## Examples
 
-### Query all delegations made from one delegator
-
-```shell
-iriscli stake delegations DelegatorAddress
+Query all delegations made from one delegator
+```
+iriscli stake delegations [delegator-address]
 ```
 
 After that, you will get all detailed info of delegations from the specified delegator address.

docs/cli-client/stake/edit-validator.md

@@ -10,7 +10,7 @@ Edit existing validator, such as commission rate, name and other description mes
 iriscli stake edit-validator [flags]
 ```
 Print help messages:
-```shell
+```
 iriscli stake edit-validator --help
 ```
 
@@ -27,6 +27,6 @@ iriscli stake edit-validator --help
 
 ## Examples
 
-```shell
+```
 iriscli stake edit-validator --from=<key name> --chain-id=<chain-id> --fee=0.004iris --commission-rate=0.15
 ```

docs/cli-client/stake/parameters.md

@@ -9,24 +9,15 @@ Query the current staking parameters information
 ```
 iriscli stake parameters [flags]
 ```
-
-## Flags
-
-| Name, shorthand            | Default                    | Description                                                         | Required |
-| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- |
-| --chain-id                 |                            | [string] Chain ID of tendermint node                                |          |
-| --height                   | most recent provable block | block height to query                                               |          |
-| --help, -h                 |                            | help for parameters                                                  |          |
-| --indent                   |                            | Add indent to JSON response                                         |          |
-| --ledger                   |                            | Use a connected Ledger device                                       |          |
-| --node                     | tcp://localhost:26657      | [string] \<host>:\<port> to tendermint rpc interface for this chain |          |
-| --trust-node               | true                       | Don't verify proofs for responses                                   |          |
+Print help messages:
+```
+iriscli stake parameters --help
+```
 
 ## Examples
 
-### Query the current staking parameters information
-
-```shell
+Query the current staking parameters information
+```
 iriscli stake parameters
 ```
 

docs/cli-client/stake/pool.md

@@ -9,24 +9,15 @@ Query the current staking pool values
 ```
 iriscli stake pool [flags]
 ```
-
-## Flags
-
-| Name, shorthand            | Default                    | Description                                                         | Required |
-| -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- |
-| --chain-id                 |                            | [string] Chain ID of tendermint node                                |          |
-| --height                   | most recent provable block | block height to query                                               |          |
-| --help, -h                 |                            | help for pool                                                  |          |
-| --indent                   |                            | Add indent to JSON response                                         |          |
-| --ledger                   |                            | Use a connected Ledger device                                       |          |
-| --node                     | tcp://localhost:26657      | [string] \<host>:\<port> to tendermint rpc interface for this chain |          |
-| --trust-node               | true                       | Don't verify proofs for responses                                   |          |
+Print help messages:
+```
+iriscli stake pool --help
+```
 
 ## Examples
 
-### Query the current staking pool values
-
-```shell
+Query the current staking pool values
+```
 iriscli stake pool
 ```
 

docs/cli-client/stake/redelegate.md

@@ -10,9 +10,9 @@ Transfer delegation from one validator to another one.
 iriscli stake redelegate [flags]
 ```
 
-Print all help messages:
+Print help messages:
 
-```shell
+```
 iriscli stake redelegate --help
 ```
 
@@ -29,6 +29,6 @@ Users must specify the redeleagtion token amount. There two options can do this:
 
 ## Examples
 
-```shell
+```
 iriscli stake redelegate --chain-id=<chain-id> --from=<key name> --fee=0.004iris --address-validator-source=<SourceValidatorAddress> --address-validator-dest=<DestinationValidatorAddress> --shares-percent=0.1
 ```

docs/cli-client/stake/redelegation.md

@@ -9,27 +9,23 @@ Query a redelegation record based on delegator and a source and destination vali
 ```
 iriscli stake redelegation [flags]
 ```
+Print help messages:
+```
+iriscli stake redelegation --help
+```
 
-## Flags
+## Unique Flags
 
 | Name, shorthand            | Default                    | Description                                                         | Required |
 | -------------------------- | -------------------------- | ------------------------------------------------------------------- | -------- | 
 | --address-delegator        |                            | [string] Bech address of the delegator                              | Yes      |
 | --address-validator-dest   |                            | [string] Bech address of the destination validator                  | Yes      |
 | --address-validator-source |                            | [string] Bech address of the source validator                       | Yes      |
-| --chain-id                 |                            | [string] Chain ID of tendermint node                                |          |
-| --height                   | most recent provable block | block height to query                                               |          |
-| --help, -h                 |                            | help for redelegation                                               |          |
-| --indent                   |                            | Add indent to JSON response                                         |          |
-| --ledger                   |                            | Use a connected Ledger device                                       |          |
-| --node                     | tcp://localhost:26657      | [string] \<host>:\<port> to tendermint rpc interface for this chain |          |
-| --trust-node               | true                       | Don't verify proofs for responses                                   |          |
 
 ## Examples
 
-### Query a redelegation record
-
-```shell
+Query a redelegation record
+```
 iriscli stake redelegation --address-validator-source=SourceValidatorAddress --address-validator-dest=DestinationValidatorAddress --address-delegator=DelegatorAddress
 ```