Dvc: standardize order of command options (flags) in help messages?

Created on 29 May 2019  路  2Comments  路  Source: iterative/dvc

For example:

$ dvc checkout -h
usage: dvc checkout [-h] [-q | -v] [-d] [-f] [-R] [targets [targets ...]]

...

optional arguments:
  -h, --help       show this help message and exit
  -q, --quiet      Be quiet.
  -v, --verbose    Be verbose.
  -d, --with-deps  Checkout all dependencies of the specified target.
  -f, --force      Do not prompt when removing working directory files.
  -R, --recursive  Checkout all subdirectories of the specified directory.

vs.

$ dvc commit -h  
usage: dvc commit [-h] [-q | -v] [-f] [-d] [-R] [targets [targets ...]]

...

optional arguments:
  -h, --help       show this help message and exit
  -q, --quiet      Be quiet.
  -v, --verbose    Be verbose.
  -f, --force      Commit even if checksums for dependencies/outputs changed.
  -d, --with-deps  Commit all dependencies of the specified target.
  -R, --recursive  Commit cache for subdirectories of the specified directory.
  • [ ] Having the same flags, their orders are -d -f -R vs -f -d -R, respectively. Should have the same order?

  • [ ] These commands have the general options -h, -q, -v displayed first and in that order like in most commands, except dvc status -h. Should fix?

  • [ ] Find any other inconsistencies and fix them?

enhancement

Most helpful comment

Sure @vibhor98 ! I've assigned it to @schecklein just to make sure that no one takes it by mistake. Thanks a lot for looking into it! :slightly_smiling_face:

All 2 comments

Hi @shcheklein, I would like to work on this issue, Thanks!

Sure @vibhor98 ! I've assigned it to @schecklein just to make sure that no one takes it by mistake. Thanks a lot for looking into it! :slightly_smiling_face:

Was this page helpful?
0 / 5 - 0 ratings