Add deprecation info of version flag
#2834
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…-v3-in-sncast-commands-that-accept---version
kkawula
requested review from
cptartur,
ddoktorski and
franciszekjob
as code owners
cptartur
reviewed
Jan 9, 2025
ksew1
reviewed
Jan 9, 2025
There was a problem hiding this comment.
It think this would be more readable instead of current macro
use anyhow::Error;
use clap::ValueEnum;
use shared::print::print_as_warning;
const DEPRECATION_MESSAGE: &str = "The '--version' flag is deprecated and will be removed in the future. Version 3 will become the only type of transaction available.";
pub fn parse_version<T: ValueEnum>(s: &str) -> Result<T, String> {
print_as_warning(&Error::msg(DEPRECATION_MESSAGE));
let ignore_case = false; // please check if it should be true of false to not make breaking changes
T::from_str(s, ignore_case)
}There was a problem hiding this comment.
Additionally, I think it would be better to change the signature of print_as_warning from:
pub fn print_as_warning(error: &Error)to:
pub fn print_as_warning(error: impl Display)This way, we wouldn't need to use the awkward workaround &Error::msg(DEPRECATION_MESSAGE) and could simply pass DEPRECATION_MESSAGE directly 😊
There was a problem hiding this comment.
Cool, it will simplify a lot, also some tests can be removed then
There was a problem hiding this comment.
- Shouldn't we update this message then? If someone uses
--tokenwe sayUse '--version' insteadwhile version will be deprecated too. I think we can just removeUse '--version' insteadsentence. - CI is failing 👀
Otherwise looks fine 👍
…-v3-in-sncast-commands-that-accept---version
franciszekjob
approved these changes
Jan 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #2828
Introduced changes
Checklist
CHANGELOG.md