How to parse inline code both on command line and rst?

[fgvieira]

I have some arguments with inline code. For example:

    group_exec.add_argument(
        "--dry-run",
        "--dryrun",
        "-n",
        dest="dryrun",
        action="store_true",
        help="Do not execute anything, and display what would be done. If you have a very large workflow, use `--dry-run --quiet` to just print a summary of the DAG of jobs.",
    )

Ideally, this would show as:

Do not execute anything, and display what would be done. If you have a very large workflow, use --dry-run --quiet to just print a summary of the DAG of jobs.

But, since it gets converted to RST, it gets parsed as:

Do not execute anything, and display what would be done. If you have a very large workflow, use `--dry-run --quiet` to just print a summary of the DAG of jobs.

I guess I could have:

    group_exec.add_argument(
        "--dry-run",
        "--dryrun",
        "-n",
        dest="dryrun",
        action="store_true",
        help="Do not execute anything, and display what would be done. If you have a very large workflow, use ``--dry-run --quiet`` to just print a summary of the DAG of jobs.",
    )

But it would look weird when running -h in the command line.

Is there a way to show the help in the command-line as single back-ticks but to be rendered as inline code?

thanks,

[RobertoRoos]

Actually, --dry-run --quiet (single backticks) in RST for me gets formatted as italics:

From what I can tell quickly this is not official, how single ticks are formatted is not properly pinned in the reST standard.

Regardless, we could indeed add an option to replace single ticks by two, for proper formatting in Sphinx. I myself have just used double ticks in the argparse configuration before, I don't think it looks so out of place in the 'help' message.