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.

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

Spelling and grammar fixes #2670

Merged
merged 1 commit into from Dec 10, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/changelog.rst
Expand Up @@ -363,7 +363,7 @@ Bugfixes - 4.0.0a7
- Enable setting a different ``upstream`` repository for the coverage diff report.
This has been hardcoded to ``upstream/rewrite`` until now.
by :user:`jugmac00`. (:issue:`1972`)
- Enable replacements (a.k.a section substitions) for section names containing a dash in sections
- Enable replacements (a.k.a section substitutions) for section names containing a dash in sections
without the ``testenv:`` prefix - by :user:`jugmac00`, :user:`obestwalter`, :user:`eumiro`. (:issue:`1985`)
- Fix legacy list env command for empty/missing envlist - by :user:`jugmac00`. (:issue:`1987`)
- Requirements and constraints files handling got reimplemented, which should fix all open issues related to this area
Expand Down Expand Up @@ -413,7 +413,7 @@ Features - 4.0.0a6
final report will be soon printed and makes the status update redundant) - by :user:`gaborbernat`. (:issue:`1909`)
- The ``_TOX_SHOW_THREAD`` environment variable can be used to print alive threads when tox exists (useful to debug
when tox hangs because of some non-finished thread) and also now prints the pid of the local subprocess when reporting
the outcome of a execution - by :user:`gaborbernat`. (:pull:`1915`)
the outcome of an execution - by :user:`gaborbernat`. (:pull:`1915`)

Bugfixes - 4.0.0a6
~~~~~~~~~~~~~~~~~~
Expand Down
8 changes: 4 additions & 4 deletions docs/config.rst
Expand Up @@ -15,8 +15,8 @@ Out of box tox supports three configuration locations prioritized in the followi
2. ``pyproject.toml``,
3. ``setup.cfg``.

As far as the configuration format at the moment we only support a *ini-style*. ``tox.ini`` and ``setup.cfg`` are by
nature such file, while in ``pyprojec.toml`` currently you can only inline the *ini-style* config.
With regards to the configuration format, at the moment we only support *ini-style*. ``tox.ini`` and ``setup.cfg`` are by
nature such files, while in ``pyproject.toml`` currently you can only inline the *ini-style* config.

Note that ``setup.cfg`` requires the content to be under the ``tox:tox`` and ``testenv`` sections and is otherwise
ignored. ``pyproject.toml`` on the other hand is in TOML format. However, one can inline the *ini-style* format under
Expand Down Expand Up @@ -72,7 +72,7 @@ to the default value for that setting. For example:

``pyproject.toml``
~~~~~~~~~~~~~~~~~~
You can inline a ``tox.ini`` style configuration under the ``tool:tox`` section and ``legacy_tox_ini`` key.
You can inline a ``tox.ini`` style configuration under the ``tool.tox`` section and ``legacy_tox_ini`` key.

Below you find the specification for the *ini-style* format, but you might want to skim some
examples first and use this page as a reference.
Expand Down Expand Up @@ -223,7 +223,7 @@ Python language core options
tox allows setting the Python version for an environment via the :ref:`basepython` setting. If that's not set tox
can set a default value from the environment name (e.g. ``py310`` implies Python 3.10). Matching up the Python
version with the environment name has became expected at this point, leading to surprises when some configs don't
do so. To help with sanity of users a error will be raised whenever the environment name version does not matches
do so. To help with sanity of users, an error will be raised whenever the environment name version does not match
up with this expectation.

Furthermore, we allow hard enforcing this rule by setting this flag to ``true``. In such cases we ignore the
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide.rst
Expand Up @@ -60,7 +60,7 @@ Then we define separately what should the formatting environment (``testenv:form
For testing the project we use the ``py310`` environment, for which we:

- define a text description of the environment,
- specify that requires ``pytest`` ``7`` ot later together with the :pypi:`pytest-sugar` project,
- specify that requires ``pytest`` ``7`` or later together with the :pypi:`pytest-sugar` project,
- and that the tool should be invoked via the ``pytest tests`` CLI command.

``{posargs}`` is a place holder part for the CLI command that allows us to pass additional flags to the pytest
Expand Down