From 3f4563e286b6d28d8c4076e39402768f57a1b77a Mon Sep 17 00:00:00 2001 From: Rootul P Date: Wed, 12 Jul 2023 13:22:42 -0400 Subject: [PATCH] docs: clarify software upgrade proposals are legacy (#16954) --- x/upgrade/types/proposal.go | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/x/upgrade/types/proposal.go b/x/upgrade/types/proposal.go index 91d40e4962..ebac9a18eb 100644 --- a/x/upgrade/types/proposal.go +++ b/x/upgrade/types/proposal.go @@ -9,7 +9,9 @@ const ( ProposalTypeCancelSoftwareUpgrade string = "CancelSoftwareUpgrade" ) -// NewSoftwareUpgradeProposal creates a new SoftwareUpgradeProposal instance +// NewSoftwareUpgradeProposal creates a new SoftwareUpgradeProposal instance. +// Deprecated: this proposal is considered legacy and is deprecated in favor of +// Msg-based gov proposals. See MsgSoftwareUpgrade. func NewSoftwareUpgradeProposal(title, description string, plan Plan) gov.Content { return &SoftwareUpgradeProposal{title, description, plan} } @@ -42,7 +44,9 @@ func (sup *SoftwareUpgradeProposal) ValidateBasic() error { return gov.ValidateAbstract(sup) } -// NewCancelSoftwareUpgradeProposal creates a new CancelSoftwareUpgradeProposal instance +// NewCancelSoftwareUpgradeProposal creates a new CancelSoftwareUpgradeProposal +// instance. Deprecated: this proposal is considered legacy and is deprecated in +// favor of Msg-based gov proposals. See MsgCancelUpgrade. func NewCancelSoftwareUpgradeProposal(title, description string) gov.Content { return &CancelSoftwareUpgradeProposal{title, description} }