Skip to content

Commit

Permalink
Fix badge link and code formatting (#2053)
Browse files Browse the repository at this point in the history
* Fix badge link and code formatting

And fix some typos.

* Update CONTRIBUTORS

* Update CONTRIBUTORS

Co-authored-by: Jürgen Gmach <[email protected]>

Co-authored-by: Jürgen Gmach <[email protected]>
  • Loading branch information
hugovk and jugmac00 authored May 2, 2021
1 parent a0f0572 commit 2d820ec
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 6 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTORS
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ Gleb Nikonorov
Gonéri Le Bouder
Hazal Ozturk
Henk-Jaap Wagenaar
Hugo van Kemenade
Ian Stapleton Cordasco
Igor Duarte Cardoso
Ilya Kulakov
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![PyPI](https://img.shields.io/pypi/v/tox?style=flat-square)
[![PyPI](https://img.shields.io/pypi/v/tox?style=flat-square)](https://pypi.org/project/tox/)
[![Supported Python
versions](https://img.shields.io/pypi/pyversions/tox.svg)](https://pypi.org/project/tox/)
[![Azure Pipelines build
Expand Down Expand Up @@ -33,7 +33,7 @@ the configuration.

To test a simple project that has some tests, here is an example with a `tox.ini` in the root of the project:

```{.sourceCode .ini}
```ini
[tox]
envlist = py37,py38

Expand All @@ -42,7 +42,7 @@ deps = pytest
commands = pytest
```

```{.sourceCode .console}
```console
$ tox

[lots of output from what tox does]
Expand All @@ -54,7 +54,7 @@ __________________ summary _________________
congratulations :)
```

tox created two `testenvs` - one based on Python3.7 and one based on Python3.8, it installed pytest in them and ran the
tox created two `testenvs` - one based on Python 3.7 and one based on Python 3.8, it installed pytest in them and ran the
tests. The report at the end summarizes which `testenvs` have failed and which have succeeded.

**Note:** To learn more about what you can do with tox, have a look at
Expand All @@ -63,7 +63,7 @@ tests. The report at the end summarizes which `testenvs` have failed and which h

### How it works

tox creates virtual environments for all configured so called `testenvs`, it then installs the project and other
tox creates virtual environments for all configured so-called `testenvs`, it then installs the project and other
necessary dependencies and runs the configured set of commands. See
[system overview](https://tox.readthedocs.io/en/latest/#system-overview) for more details.

Expand All @@ -79,7 +79,7 @@ necessary dependencies and runs the configured set of commands. See
- creating development environments
- running static code analysis and test tools
- automating package builds
- running tests against the package build by tox
- running tests against the package built by tox
- checking that packages install correctly with different Python versions/interpreters
- unifying Continuous Integration and command line based testing
- building and deploying project documentation
Expand Down

0 comments on commit 2d820ec

Please sign in to comment.