docs: clarify software upgrade proposals are legacy (#16954)

This commit is contained in:
Rootul P 2023-07-12 13:22:42 -04:00 committed by GitHub
parent dab97ed352
commit 3f4563e286
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -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}
}