FuelLabs/forc

Help message for `forc run --help` subcommand `--dry-run` is insufficient

Open

#161 opened on Sep 22, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (0 forks)auto 404
forc-clientgood first issue

Repository metrics

Stars
 (0 stars)
PR merge metrics
 (PR metrics pending)

Description

What is the difference between the two commands? I thought that --dry-run does not change the state but apparently --simulate doesn't either.

1 2

Contributor guide

Research direction
Look for the definition of the ` dry run` and ` simulate` flags in the CLI argument parser (likely using clap). Modify the help text to clearly explain that ` dry run` does not execute any state changing operations, while ` simulate` runs a simulation that may produce output but does not persist changes.
Tech stack
rust
Domain
clideveloper experience
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90