Fix descriptions for contract id commands#2618
Open
fnando wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request corrects user-facing CLI help text for the stellar contract id asset and stellar contract id wasm subcommands so the documentation matches actual behavior (deriving/printing contract IDs rather than deploying contracts).
Changes:
- Updated Clap subcommand descriptions for
contract id assetandcontract id wasmto reflect “derive contract id” semantics. - Regenerated
FULL_HELP_DOCS.mdto align the published help docs with the updated command descriptions.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| FULL_HELP_DOCS.md | Updates generated help output to reflect corrected contract id subcommand descriptions. |
| cmd/soroban-cli/src/commands/contract/id.rs | Fixes Clap subcommand docstrings for asset and wasm under stellar contract id. |
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
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.
What
Corrects the help text for the
stellar contract id assetandstellar contract id wasmsubcommands. They previously read "Deploy builtin Soroban Asset Contract" and "Deploy normal Wasm Contract", which is wrong — neither deploys anything. They now read "Derive the contract id for a builtin Stellar Asset Contract" and "Derive the contract id for a Wasm contract".FULL_HELP_DOCS.mdwas regenerated to match.Why
These subcommands derive and print a contract ID; they do not deploy. The old descriptions were inaccurate.
Known limitations
N/A