docs(cli): document installed version check#2822
Open
peter941221 wants to merge 1 commit into
Open
Conversation
peter941221
force-pushed
the
issue-2493-version-check-docs
branch
from
cad3993 to
7a2fc12
Compare
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Fixes #2493
Failure mechanism:
users installing the CLI via sp1up were not told in the CLI README how to check which cargo-prove version is currently installed, even though the binary already exposes that information and sp1up already prints it after install.
Semantic change:
document cargo prove --version in the CLI README and note that sp1up prints the installed version after download.
Preserved invariant:
this does not change CLI or installer behavior; it only documents the already-supported version check path suggested in the issue discussion.
Testing:
validated with git diff --check. No code-path validation was needed because the patch is documentation-only and points to existing behavior in crates/cli/src/bin/cargo-prove.rs and sp1up/sp1up.