Skip to content

Formatting of trace command broken #5

Description

@mcnaughtonadm

The click documentation presented for the trace command looks broken:

Commands:
  shuffle  Generate randomized plate maps from a list of...
  trace    Trace the samples over their various plates.
mcnaughtonadm@seurat:~$ uvx wellshuffled trace
WellShuffled: A tool for generating randomized plate maps.
Usage: wellshuffled trace [OPTIONS] INPUT_PATH
Try 'wellshuffled trace --help' for help.

Error: Missing argument 'INPUT_PATH'.
mcnaughtonadm@seurat:~$ uvx wellshuffled trace --help
WellShuffled: A tool for generating randomized plate maps.
Usage: wellshuffled trace [OPTIONS] INPUT_PATH

  Trace the samples over their various plates.

  Parameters ---------- input_path : str     Path to a
  directory of plate files or a single combined plate file.
  output_csv : str, optional     Path to save the full
  trajectory map as a CSV file. use_numeric_wells : bool,
  optional     Return the plate positions as 1-based column
  major numeric values.

Options:
  --output-csv PATH  Optional path to save the full
                     trajectory map as a CSV file.
  --numeric          Return the plate positions as 1-based
                     column major numeric values.
  --help             Show this message and exit.

We need to clean up the doc for the trace command

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions