From 4bc269c95e5aa79286539b338d37ef8ac6b505e7 Mon Sep 17 00:00:00 2001 From: Carlos LopezDeLara Date: Mon, 16 Dec 2024 12:55:00 -0600 Subject: [PATCH] improve help text improve query proposals help text. --- cardano-cli/src/Cardano/CLI/EraBased/Options/Query.hs | 6 +++++- cardano-cli/test/cardano-cli-golden/files/golden/help.cli | 8 ++++++-- .../cardano-cli-golden/files/golden/help/conway_query.cli | 5 ++++- .../files/golden/help/conway_query_proposals.cli | 4 +++- .../cardano-cli-golden/files/golden/help/latest_query.cli | 5 ++++- .../files/golden/help/latest_query_proposals.cli | 4 +++- 6 files changed, 25 insertions(+), 7 deletions(-) diff --git a/cardano-cli/src/Cardano/CLI/EraBased/Options/Query.hs b/cardano-cli/src/Cardano/CLI/EraBased/Options/Query.hs index a8884ebe21..d1e84b5939 100644 --- a/cardano-cli/src/Cardano/CLI/EraBased/Options/Query.hs +++ b/cardano-cli/src/Cardano/CLI/EraBased/Options/Query.hs @@ -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 = diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help.cli index 590ec29af4..b0d9efa7d2 100644 --- a/cardano-cli/test/cardano-cli-golden/files/golden/help.cli +++ b/cardano-cli/test/cardano-cli-golden/files/golden/help.cli @@ -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 @@ -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 diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_query.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_query.cli index 67fb235016..694e2d48a1 100644 --- a/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_query.cli +++ b/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_query.cli @@ -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. diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_query_proposals.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_query_proposals.cli index 06e06095e9..1c353dfd03 100644 --- a/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_query_proposals.cli +++ b/cardano-cli/test/cardano-cli-golden/files/golden/help/conway_query_proposals.cli @@ -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 diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_query.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_query.cli index 24254c1fb8..0d73ff5604 100644 --- a/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_query.cli +++ b/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_query.cli @@ -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. diff --git a/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_query_proposals.cli b/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_query_proposals.cli index d56bc92fb3..54a4b3f332 100644 --- a/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_query_proposals.cli +++ b/cardano-cli/test/cardano-cli-golden/files/golden/help/latest_query_proposals.cli @@ -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