Skip to content

Commit

Permalink
improve help text
Browse files Browse the repository at this point in the history
improve query proposals help text.
  • Loading branch information
CarlosLopezDeLara committed Dec 17, 2024
1 parent 3388452 commit 4bc269c
Show file tree
Hide file tree
Showing 6 changed files with 25 additions and 7 deletions.
6 changes: 5 additions & 1 deletion cardano-cli/src/Cardano/CLI/EraBased/Options/Query.hs
Original file line number Diff line number Diff line change
Expand Up @@ -531,7 +531,11 @@ pQueryProposalsCmd era envCli = do
pure $
subParser "proposals" $
Opt.info (QueryProposalsCmd <$> pQueryProposalsCmdArgs w) $
Opt.progDesc "Get the governance proposals."
Opt.progDesc $
mconcat
[ "Get the governance proposals that are eligible for ratification. "
, "Proposals submitted during the current epoch are excluded, as they cannot be ratified until the next epoch. "
]
where
pQueryProposalsCmdArgs :: ConwayEraOnwards era -> Parser (QueryProposalsCmdArgs era)
pQueryProposalsCmdArgs w =
Expand Down
8 changes: 6 additions & 2 deletions cardano-cli/test/cardano-cli-golden/files/golden/help.cli
Original file line number Diff line number Diff line change
Expand Up @@ -7622,7 +7622,9 @@ Usage: cardano-cli conway query proposals --socket-path SOCKET_PATH
)
[--out-file FILEPATH]

Get the governance proposals.
Get the governance proposals that are eligible for ratification. Proposals
submitted during the current epoch are excluded, as they cannot be ratified
until the next epoch.

Usage: cardano-cli conway stake-address
( key-gen
Expand Down Expand Up @@ -9638,7 +9640,9 @@ Usage: cardano-cli latest query proposals --socket-path SOCKET_PATH
)
[--out-file FILEPATH]

Get the governance proposals.
Get the governance proposals that are eligible for ratification. Proposals
submitted during the current epoch are excluded, as they cannot be ratified
until the next epoch.

Usage: cardano-cli latest stake-address
( key-gen
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,7 @@ Available commands:
spo-stake-distribution Get the SPO stake distribution.
committee-state Get the committee state
treasury Get the treasury value
proposals Get the governance proposals.
proposals Get the governance proposals that are eligible for
ratification. Proposals submitted during the current
epoch are excluded, as they cannot be ratified until
the next epoch.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ Usage: cardano-cli conway query proposals --socket-path SOCKET_PATH
)
[--out-file FILEPATH]

Get the governance proposals.
Get the governance proposals that are eligible for ratification. Proposals
submitted during the current epoch are excluded, as they cannot be ratified
until the next epoch.

Available options:
--socket-path SOCKET_PATH
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -65,4 +65,7 @@ Available commands:
spo-stake-distribution Get the SPO stake distribution.
committee-state Get the committee state
treasury Get the treasury value
proposals Get the governance proposals.
proposals Get the governance proposals that are eligible for
ratification. Proposals submitted during the current
epoch are excluded, as they cannot be ratified until
the next epoch.
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ Usage: cardano-cli latest query proposals --socket-path SOCKET_PATH
)
[--out-file FILEPATH]

Get the governance proposals.
Get the governance proposals that are eligible for ratification. Proposals
submitted during the current epoch are excluded, as they cannot be ratified
until the next epoch.

Available options:
--socket-path SOCKET_PATH
Expand Down

0 comments on commit 4bc269c

Please sign in to comment.