update comment on ignore_basepython_conflict

the current comment implies that setting
ignore_basepython_conflict simply silences
the warning emitted if the base python version
set in the gloabl [testenv] section conflicts
with the automatic python version selected form the
test env name .e.g. py27

this is not correct as the upstream documentation
states setting ignore_basepython_conflict=true
allow enforcing this rule that py37 implies python3.7
however when its is not set basepython from [testenv]
override the implied version form the env name.

https://tox.readthedocs.io/en/latest/config.html#conf-ignore_basepython_conflict

This change updates the comment to reflect that.

Change-Id: Ieab65a2a9c6309021d5ee91e56ac07889a9e9bc4
Related-Bug: #1832652
This commit is contained in:
Sean Mooney 2019-06-13 00:29:23 +01:00
parent 55da4e1305
commit cc615d0957
1 changed files with 3 additions and 3 deletions

View File

@ -1,9 +1,9 @@
[tox]
minversion = 3.1.1
envlist = py{27,36,37},functional,pep8
# Automatic envs (pyXX) will use the python version appropriate to that
# env and ignore basepython inherited from [testenv]. That's what we
# want, and we don't need to be warned about it.
# Automatic envs (pyXX) will only use the python version appropriate to that
# env and ignore basepython inherited from [testenv] if we set
# ignore_basepython_conflict.
ignore_basepython_conflict = True
[testenv]