Clarify input vs. output directories in the validator CLI arguments

Open Beginner friendly
#1,807 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
75/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Stale
Tech stack
rust
Domain
cli

Research direction

Look at the validator CLI code to find where the arguments like genesis_block_directory and genesis_config_file are defined and used. Check the help text and any existing documentation. Update the argument descriptions to clearly indicate whether they are input or output locations. Run the CLI with --help to verify the changes.

Written by the indexing model from the issue text.

Description

validator

This might be for a separate discussion/PR, but I find the argument names a little misleading: it's not immediately clear whether these are input directories or output directories, for example:

  • genesis_block_directory is an output location, but
  • genesis_config_file is an input location (here, path, not a directory, but the same argument applies)

Originally posted by @mmagician in https://github.com/0xMiden/node/pull/1774#discussion_r2952439567

Dominant language
Rust
Stars
105
Forks
139
Avg merge
1d 22h
Merged PRs (30d)
61

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from 0xMiden/node

All issues in 0xMiden/node

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.