Skip to content

Commit

Permalink
docs: indicate commands as deprecated
Browse files Browse the repository at this point in the history
  • Loading branch information
@nicolasbrugneaux
nicolasbrugneaux committed Nov 14, 2024
1 parent fcab7a7 commit 521f499
Show file tree
Hide file tree
Showing 2 changed files with 123 additions and 15 deletions.
126 changes: 114 additions & 12 deletions docs/command-line-interface/governance.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -413,8 +413,9 @@ Show information about a governance proposal, hotfix, or account.
USAGE
$ celocli governance:show [--gasCurrency
0x1234567890123456789012345678901234567890] [--globalHelp] [--raw]
[--jsonTransactions <value>] [--proposalID <value> | --account <value> | --hotfix
<value>] [--afterExecutingProposal <value> | --afterExecutingID <value>]
[--jsonTransactions <value>] [--notwhitelisted] [--whitelisters | --nonwhitelisters
| | [--proposalID <value> | --account <value> | --hotfix <value>]]
[--afterExecutingProposal <value> | --afterExecutingID <value>]
FLAGS
--account=<value> Address of account or voter
Expand All @@ -434,9 +435,21 @@ FLAGS
--hotfix=<value> Hash of hotfix proposal
--jsonTransactions=<value> Output proposal JSON to
provided file
--nonwhitelisters If set, displays validators
that have not whitelisted
the hotfix.(will be removed
when L2 launches
--notwhitelisted List validators who have not
whitelisted the specified
hotfix (will be removed when
L2 launches
--proposalID=<value> UUID of proposal to view
--raw Display proposal in raw
bytes format
--whitelisters If set, displays validators
that have whitelisted the
hotfix.(will be removed when
L2 launches
DESCRIPTION
Show information about a governance proposal, hotfix, or account.
Expand All @@ -456,6 +469,10 @@ EXAMPLES
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 --whitelisters
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 --nonwhitelisters
show --account 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95
```

Expand All @@ -469,8 +486,9 @@ Show information about a governance proposal, hotfix, or account.
USAGE
$ celocli governance:showaccount [--gasCurrency
0x1234567890123456789012345678901234567890] [--globalHelp] [--raw]
[--jsonTransactions <value>] [--proposalID <value> | --account <value> | --hotfix
<value>] [--afterExecutingProposal <value> | --afterExecutingID <value>]
[--jsonTransactions <value>] [--notwhitelisted] [--whitelisters | --nonwhitelisters
| | [--proposalID <value> | --account <value> | --hotfix <value>]]
[--afterExecutingProposal <value> | --afterExecutingID <value>]
FLAGS
--account=<value> Address of account or voter
Expand All @@ -490,9 +508,21 @@ FLAGS
--hotfix=<value> Hash of hotfix proposal
--jsonTransactions=<value> Output proposal JSON to
provided file
--nonwhitelisters If set, displays validators
that have not whitelisted
the hotfix.(will be removed
when L2 launches
--notwhitelisted List validators who have not
whitelisted the specified
hotfix (will be removed when
L2 launches
--proposalID=<value> UUID of proposal to view
--raw Display proposal in raw
bytes format
--whitelisters If set, displays validators
that have whitelisted the
hotfix.(will be removed when
L2 launches
DESCRIPTION
Show information about a governance proposal, hotfix, or account.
Expand All @@ -512,6 +542,10 @@ EXAMPLES
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 --whitelisters
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 --nonwhitelisters
show --account 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95
```

Expand All @@ -523,8 +557,9 @@ Show information about a governance proposal, hotfix, or account.
USAGE
$ celocli governance:showhotfix [--gasCurrency
0x1234567890123456789012345678901234567890] [--globalHelp] [--raw]
[--jsonTransactions <value>] [--proposalID <value> | --account <value> | --hotfix
<value>] [--afterExecutingProposal <value> | --afterExecutingID <value>]
[--jsonTransactions <value>] [--notwhitelisted] [--whitelisters | --nonwhitelisters
| | [--proposalID <value> | --account <value> | --hotfix <value>]]
[--afterExecutingProposal <value> | --afterExecutingID <value>]
FLAGS
--account=<value> Address of account or voter
Expand All @@ -544,9 +579,21 @@ FLAGS
--hotfix=<value> Hash of hotfix proposal
--jsonTransactions=<value> Output proposal JSON to
provided file
--nonwhitelisters If set, displays validators
that have not whitelisted
the hotfix.(will be removed
when L2 launches
--notwhitelisted List validators who have not
whitelisted the specified
hotfix (will be removed when
L2 launches
--proposalID=<value> UUID of proposal to view
--raw Display proposal in raw
bytes format
--whitelisters If set, displays validators
that have whitelisted the
hotfix.(will be removed when
L2 launches
DESCRIPTION
Show information about a governance proposal, hotfix, or account.
Expand All @@ -566,6 +613,10 @@ EXAMPLES
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 --whitelisters
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 --nonwhitelisters
show --account 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95
```

Expand Down Expand Up @@ -608,8 +659,9 @@ Show information about a governance proposal, hotfix, or account.
USAGE
$ celocli governance:view [--gasCurrency
0x1234567890123456789012345678901234567890] [--globalHelp] [--raw]
[--jsonTransactions <value>] [--proposalID <value> | --account <value> | --hotfix
<value>] [--afterExecutingProposal <value> | --afterExecutingID <value>]
[--jsonTransactions <value>] [--notwhitelisted] [--whitelisters | --nonwhitelisters
| | [--proposalID <value> | --account <value> | --hotfix <value>]]
[--afterExecutingProposal <value> | --afterExecutingID <value>]
FLAGS
--account=<value> Address of account or voter
Expand All @@ -629,9 +681,21 @@ FLAGS
--hotfix=<value> Hash of hotfix proposal
--jsonTransactions=<value> Output proposal JSON to
provided file
--nonwhitelisters If set, displays validators
that have not whitelisted
the hotfix.(will be removed
when L2 launches
--notwhitelisted List validators who have not
whitelisted the specified
hotfix (will be removed when
L2 launches
--proposalID=<value> UUID of proposal to view
--raw Display proposal in raw
bytes format
--whitelisters If set, displays validators
that have whitelisted the
hotfix.(will be removed when
L2 launches
DESCRIPTION
Show information about a governance proposal, hotfix, or account.
Expand All @@ -651,6 +715,10 @@ EXAMPLES
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 --whitelisters
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 --nonwhitelisters
show --account 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95
```

Expand All @@ -662,8 +730,9 @@ Show information about a governance proposal, hotfix, or account.
USAGE
$ celocli governance:viewaccount [--gasCurrency
0x1234567890123456789012345678901234567890] [--globalHelp] [--raw]
[--jsonTransactions <value>] [--proposalID <value> | --account <value> | --hotfix
<value>] [--afterExecutingProposal <value> | --afterExecutingID <value>]
[--jsonTransactions <value>] [--notwhitelisted] [--whitelisters | --nonwhitelisters
| | [--proposalID <value> | --account <value> | --hotfix <value>]]
[--afterExecutingProposal <value> | --afterExecutingID <value>]
FLAGS
--account=<value> Address of account or voter
Expand All @@ -683,9 +752,21 @@ FLAGS
--hotfix=<value> Hash of hotfix proposal
--jsonTransactions=<value> Output proposal JSON to
provided file
--nonwhitelisters If set, displays validators
that have not whitelisted
the hotfix.(will be removed
when L2 launches
--notwhitelisted List validators who have not
whitelisted the specified
hotfix (will be removed when
L2 launches
--proposalID=<value> UUID of proposal to view
--raw Display proposal in raw
bytes format
--whitelisters If set, displays validators
that have whitelisted the
hotfix.(will be removed when
L2 launches
DESCRIPTION
Show information about a governance proposal, hotfix, or account.
Expand All @@ -705,6 +786,10 @@ EXAMPLES
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 --whitelisters
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 --nonwhitelisters
show --account 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95
```

Expand All @@ -716,8 +801,9 @@ Show information about a governance proposal, hotfix, or account.
USAGE
$ celocli governance:viewhotfix [--gasCurrency
0x1234567890123456789012345678901234567890] [--globalHelp] [--raw]
[--jsonTransactions <value>] [--proposalID <value> | --account <value> | --hotfix
<value>] [--afterExecutingProposal <value> | --afterExecutingID <value>]
[--jsonTransactions <value>] [--notwhitelisted] [--whitelisters | --nonwhitelisters
| | [--proposalID <value> | --account <value> | --hotfix <value>]]
[--afterExecutingProposal <value> | --afterExecutingID <value>]
FLAGS
--account=<value> Address of account or voter
Expand All @@ -737,9 +823,21 @@ FLAGS
--hotfix=<value> Hash of hotfix proposal
--jsonTransactions=<value> Output proposal JSON to
provided file
--nonwhitelisters If set, displays validators
that have not whitelisted
the hotfix.(will be removed
when L2 launches
--notwhitelisted List validators who have not
whitelisted the specified
hotfix (will be removed when
L2 launches
--proposalID=<value> UUID of proposal to view
--raw Display proposal in raw
bytes format
--whitelisters If set, displays validators
that have whitelisted the
hotfix.(will be removed when
L2 launches
DESCRIPTION
Show information about a governance proposal, hotfix, or account.
Expand All @@ -759,6 +857,10 @@ EXAMPLES
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 --whitelisters
show --hotfix 0x614dccb5ac13cba47c2430bdee7829bb8c8f3603a8ace22e7680d317b39e3658 --nonwhitelisters
show --account 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95
```

Expand Down
12 changes: 9 additions & 3 deletions packages/cli/src/commands/governance/show.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,20 @@ export default class Show extends BaseCommand {
description: 'Hash of hotfix proposal',
}),
notwhitelisted: Flags.boolean({
description: 'List validators who have not whitelisted the specified hotfix',
description:
'List validators who have not whitelisted the specified hotfix (will be removed when L2 launches',
deprecated: true,
}),
whitelisters: Flags.boolean({
description: 'If set, displays validators that have whitelisted the hotfix.',
description:
'If set, displays validators that have whitelisted the hotfix.(will be removed when L2 launches',
deprecated: true,
exclusive: ['nonwhitelisters', 'account', 'proposalID'],
}),
nonwhitelisters: Flags.boolean({
description: 'If set, displays validators that have not whitelisted the hotfix.',
description:
'If set, displays validators that have not whitelisted the hotfix.(will be removed when L2 launches',
deprecated: true,
exclusive: ['whitelisters', 'account', 'proposalID'],
}),
afterExecutingProposal: Flags.string({
Expand Down

0 comments on commit 521f499

Please sign in to comment.