Skip to content

brev search --help and best practices for the brev search -> brev search gpu alias #375

@brycelelbach

Description

@brycelelbach

brev search cpu was added after brev search when we introduced CPU instances. This has led to some inconsistencies.

Today:

  • brev search is conceptually an alias for brev search gpu.
  • brev search --help only lists the flags for brev search [gpu], not brev search cpu. brev search --help and brev search gpu --help are nearly identical, but brev search --help does mention the existence of brev search cpu, which brev search gpu --help does not.

Suggestion:

  • brev search --help should list all the options for both brev search gpu and brev search cpu.
  • brev search gpu --help should list the options only for that subcommand.
  • brev search cpu --help should list the options only for that subcommand.
  • brev search "defaulting" to brev search gpu should be considered a legacy behavior; all of our examples and docs should explicitly show brev search gpu instead of brev search.

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