Skip to content

chore: add verbatim_doc_comment in ExecCmd::inputs_path #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: next
Choose a base branch
from

Conversation

lima-limon-inc
Copy link

Clap ignores the newlines from ExecCMD::input_paths's doc-comment. This hinders the comments' readability.

This PR adds the #[clap(verbatim_doc_comment)] in order for it to follow the formatting.

For reference, here's the before and after:
Before:

$~ miden-client exec --help
Execute the specified program against the specified account
(...)

  -i, --inputs-path <INPUTS_PATH>
          Path to the inputs file. This file will be used as inputs to the VM's advice map.
          
          The file should contain a TOML array of inline tables, where each table has two fields: - `key`: a 256-bit hexadecimal string representing a word to be used as a key for the input entry. The hexadecimal value must be prefixed with 0x. - `values`: an array of 64-bit unsigned integers representing field elements to be used as values for the input entry. Each integer must be written as a separate string, within double quotes.
          
          The input file should contain a TOML table called `inputs`, as in the following example: inputs = [ { key = "0x0000001000000000000000000000000000000000000000000000000000000000", values = ["13", "9"]}, { key = "0x0000000000000000000000000000000000000000000000000000000000000000" , values = ["1", "2"]}, ]

(...)

After:

(...)
  -i, --inputs-path <INPUTS_PATH>
          Path to the inputs file. This file will be used as inputs to the VM's advice map.
          
          The file should contain a TOML array of inline tables, where each table has two fields:
          - `key`: a 256-bit hexadecimal string representing a word to be used as a key for the input
            entry. The hexadecimal value must be prefixed with 0x.
          - `values`: an array of 64-bit unsigned integers representing field elements to be used as
            values for the input entry. Each integer must be written as a separate string, within
            double quotes.
          
          The input file should contain a TOML table called `inputs`, as in the following example:
             inputs = [
                 { key = "0x0000001000000000000000000000000000000000000000000000000000000000", values = ["13", "9"]},
                 { key = "0x0000000000000000000000000000000000000000000000000000000000000000" , values = ["1", "2"]},
             ]
(...)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant