fix: Fix help generation #87
Conversation
CHANGELOG.md
Outdated
| ### Fixed | ||
|
|
||
| - Fixed help generation for all services | ||
|
|
There was a problem hiding this comment.
Since this bug wasn't in a previous release, we don't need to add a fix entry in the changelog. It is like it never existed in the first place.
| #[derive(Parser, Debug)] | ||
| #[derive(Clone, Parser)] | ||
| #[command(name = "advance_runner_config")] | ||
| #[command(about = "Configuration for rollups advance-runner")] |
There was a problem hiding this comment.
I prefer that we remove the about section. Most CLI starts with the usage.
| @@ -62,7 +62,9 @@ pub enum ConfigError { | |||
| SnapshotConfigError { source: SnapshotConfigError }, | |||
| } | |||
|
|
|||
| #[derive(Parser, Debug)] | |||
| #[derive(Clone, Parser)] | |||
There was a problem hiding this comment.
Some use case needed, not sure why. I was just making it standard. Will remove and re-check who really needs
There was a problem hiding this comment.
I guess it doesn't hurt to leave it there and It is nice to be standardized. You can leave it if you want.
fmoura
force-pushed
the
fix/fix-help-gen
branch
from
32e306f to
d31e251
Compare
fmoura
force-pushed
the
fix/fix-help-gen
branch
3 times, most recently
from
8bae15e to
683378c
Compare
There was a problem hiding this comment.
The help message still needs to be clarified.
➜ offchain git:(683378c8) ./target/debug/cartesi-rollups-advance-runner --help | head
CLI configuration used to generate the DApp metadata
Usage: cartesi-rollups-advance-runner [OPTIONS] --snapshot-dir <SNAPSHOT_DIR> --snapshot-latest <SNAPSHOT_LATEST>
If it is too hard to remove the description, we could just leave something like "Configuration for advance-runner".
I didn't test the other services.
This one comes from a Comment and not an annotation. Maybe it is best to add back again the Description for every service, so we do not fallback on presenting some unwanted description that comes from a "inner" configuration that could come from an external crate |
fmoura
force-pushed
the
fix/fix-help-gen
branch
from
683378c to
1de2314
Compare
|
Correctly tested every service and they are consistent now, looking something like this |
No description provided.