Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document conventions for command line args for tox core and plugins #498

Open
obestwalter opened this issue Mar 28, 2017 · 3 comments
Open

Document conventions for command line args for tox core and plugins #498

obestwalter opened this issue Mar 28, 2017 · 3 comments
Assignees
@gaborbernat
Labels
area:documentation help:wanted Issues that have been acknowledged, a solution determined and a PR might likely be accepted. level:easy rought estimate that this might be quite easy to implement

Comments

@obestwalter
Copy link
Member

obestwalter commented Mar 28, 2017 •
edited
Loading

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.
@gaborbernat
Copy link
Member

I'll take this.

@obestwalter obestwalter changed the title Dcoument conventions for command line args for tox core and plugins Document conventions for command line args for tox core and plugins Sep 4, 2017
@obestwalter obestwalter added area:documentation level:easy rought estimate that this might be quite easy to implement and removed documentation labels Sep 4, 2017
@gaborbernat gaborbernat self-assigned this Sep 13, 2018
@gaborbernat gaborbernat added this to the 3.5 milestone Sep 18, 2018
@gaborbernat gaborbernat modified the milestones: 3.5, 3.6 Oct 8, 2018
@gaborbernat gaborbernat modified the milestones: 3.6, 3.7 Dec 16, 2018
@gaborbernat gaborbernat added the help:wanted Issues that have been acknowledged, a solution determined and a PR might likely be accepted. label May 3, 2019
@gaborbernat
Copy link
Member

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
Copy link
Member

We can't really enforce any of this however we can make recommendations 👍

@gaborbernat gaborbernat modified the milestones: 3.7, 4.0 Jan 13, 2022
@gaborbernat gaborbernat modified the milestones: 4.0, 4.1 Nov 20, 2022
@gaborbernat gaborbernat removed this from the P-1 milestone Jun 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@gaborbernat gaborbernat

Labels
area:documentation help:wanted Issues that have been acknowledged, a solution determined and a PR might likely be accepted. level:easy rought estimate that this might be quite easy to implement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@obestwalter @gaborbernat