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.

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

config doesn't define skipsdist #683

Closed
go8ose opened this Issue Nov 28, 2017 · 2 comments

Comments

Projects
None yet
3 participants
@go8ose

go8ose commented Nov 28, 2017

Hi,

I just noticed that tox/doc/config.rst mentions that skipsdist defaults to false, but it doesn't actually say what it does.

I'm sure to an experienced python developer they'd understand that it skips the step where tox runs a /setup.py sdist And the tox/doc/example/general.rst file, in the 'Avoiding expensive sdist' section spells this out.

But as someone that just googled straight into the tox/doc/config.rst page, this wasn't immediately clear to me. Some of the other global settings are defined at the bottom of this section. Perhaps all of them should be. I also noticed that skip_missing_interpreters was defined, but missing from the list of global options.

Regards,
Geoff

@cryvate

This comment has been minimized.

Contributor

cryvate commented Nov 28, 2017

I think in general, the section on global options could do on expansion similar to the virtualenv test environment settings so that each option has its own heading. I'll have a look later

@cryvate

This comment has been minimized.

Contributor

cryvate commented Dec 13, 2017

This is still in progress: quite a few descriptions to write.

@gaborbernat gaborbernat added this to the 3.5 milestone Sep 18, 2018

gaborbernat added a commit to gaborbernat/tox that referenced this issue Sep 20, 2018

Document all global tox configuration arguments and switch to a conci…
…se format to express default and type

Resolves tox-dev#683.

@helpr helpr bot added the pr-available label Sep 20, 2018

@helpr helpr bot added pr-merged and removed pr-available labels Sep 20, 2018

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