Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve query proposals help text. #994

Merged
merged 1 commit into from
Dec 23, 2024
Merged

Improve query proposals help text. #994

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion cardano-cli/src/Cardano/CLI/EraBased/Options/Query.hs
View file
Open in desktop
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
View file
Open in desktop
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
5 changes: 4 additions & 1 deletion cardano-cli/test/cardano-cli-golden/files/golden/help/conway_query.cli
View file
Open in desktop
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.
4 changes: 3 additions & 1 deletion cardano-cli/test/cardano-cli-golden/files/golden/help/conway_query_proposals.cli
View file
Open in desktop
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
5 changes: 4 additions & 1 deletion cardano-cli/test/cardano-cli-golden/files/golden/help/latest_query.cli
View file
Open in desktop
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.
4 changes: 3 additions & 1 deletion cardano-cli/test/cardano-cli-golden/files/golden/help/latest_query_proposals.cli
View file
Open in desktop
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
Loading