nextclade icon indicating copy to clipboard operation
nextclade copied to clipboard

DOC: `--output-all` help is not explicit enough on what the supplied value is supposed to be/do

Open corneliusroemer opened this issue 2 years ago • 0 comments

I read through the help for --output-all but I'm not quite sure it explains well what the argument is supposed to be.

I think it's the directory that we want to put the output files in, but this isn't mentioned as explicitly as it could be.

Would it be possible to change the help to something like:

    -O, --output-all <OUTPUT_DIRECTORY_PATH>
            Produce all of the output files into <OUTPUT_DIRECTORY_PATH>, using default basename and
            predefined suffixes and extensions. This is equivalent to specifying each of the
            individual `--output-*` flags. Convenient when you want to receive all or most of output
            files into the same directory and don't care about their filenames.
            
            Output files can be optionally included or excluded using `--output-selection` flag. The
            base filename can be set using `--output-basename` flag.
            
            If both the `--output-all` and individual `--output-*` flags are provided, each
            individual flag overrides the corresponding default output path.
            
            At least one of the output flags is required: `--output-all`, `--output-fasta`,
            `--output-ndjson`, `--output-json`, `--output-csv`, `--output-tsv`, `--output-tree`,
            `--output-translations`, `--output-insertions`, `--output-errors`
            
            If the required directory tree does not exist, it will be created.

corneliusroemer avatar Jun 29 '22 12:06 corneliusroemer