tox icon indicating copy to clipboard operation
tox copied to clipboard

Document conventions for command line args for tox core and plugins

Open obestwalter opened this issue 8 years ago • 3 comments

As @hpk42 mentioned certain conventions have been growing to prevent command line args clashes between tox core and plugins, which boil down to

  • tox -> lowercase switches and long options
  • plugins -> only uppercase switches (and no long options? Not sure about that yet)

This should be documented in the plugins docs.

obestwalter avatar Mar 28 '17 11:03 obestwalter

I'll take this.

gaborbernat avatar Apr 06 '17 21:04 gaborbernat

I don't think this will solve things reliably. I would suggest instead plugin option should start with the plugin part, e.g. tox-travis should have --travis--a, tox-docker should have --docker-b and so on.

gaborbernat avatar May 03 '19 04:05 gaborbernat

We can't really enforce any of this however we can make recommendations :+1:

gaborbernat avatar Jan 13 '22 10:01 gaborbernat