sim-cli: Improves CLI docs so help has a more friendly report #145
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
sr-gi
force-pushed
the
20231018-improve-help
branch
3 times, most recently
from
7acc6b2 to
e6771ac
Compare
carlaKC
reviewed
Oct 20, 2023
sim-lib/src/lib.rs
Outdated
| print_batch_size: print_batch_size.unwrap_or(DEFAULT_PRINT_BATCH_SIZE), | ||
| expected_payment_msat: expected_payment_amount.unwrap_or(EXPECTED_PAYMENT_AMOUNT), | ||
| activity_multiplier: activity_multiplier.unwrap_or(ACTIVITY_MULTIPLIER), | ||
| print_batch_size: print_batch_size, |
sr-gi
force-pushed
the
20231018-improve-help
branch
from
e6771ac to
14b806e
Compare
|
This should be good now |
carlaKC
approved these changes
Oct 20, 2023
… are covered. This makes some optional params to the simulator mandatory and moves the defaulting behavior to the CLI so clap can take care of it. The main rationale for it is so we can easily report the defaults. Also, restricts `print_batch_size` to be `> 0`.
sr-gi
force-pushed
the
20231018-improve-help
branch
from
14b806e to
de1b2cb
Compare
okjodom
pushed a commit
to okjodom/sim-ln
that referenced
this pull request
Nov 8, 2023
… are covered. (bitcoin-dev-project#145) This makes some optional params to the simulator mandatory and moves the defaulting behavior to the CLI so clap can take care of it. The main rationale for it is so we can easily report the defaults. Also, restricts `print_batch_size` to be `> 0`.
okjodom
pushed a commit
that referenced
this pull request
Nov 8, 2023
… are covered. (#145) This makes some optional params to the simulator mandatory and moves the defaulting behavior to the CLI so clap can take care of it. The main rationale for it is so we can easily report the defaults. Also, restricts `print_batch_size` to be `> 0`.
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.
sim-cli helpis pretty unfriendly atm, add docs so the args/options are covered.This makes some optional params to the simulator mandatory and moves the defaulting behavior to the CLI so clap can take care of it. The main rationale for it is so we can easily report the defaults.
Also, restricts
print_batch_sizeto be> 0, as discussed #146 (comment)