From 6f056cafcca6cee4b23a35fdfc2044647c99e8d7 Mon Sep 17 00:00:00 2001 From: James Williams Date: Wed, 28 Dec 2022 20:42:46 -0600 Subject: [PATCH] Update user_guide.rst (#2787) Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> --- docs/changelog/2787.doc.rst | 1 + docs/user_guide.rst | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 docs/changelog/2787.doc.rst diff --git a/docs/changelog/2787.doc.rst b/docs/changelog/2787.doc.rst new file mode 100644 index 000000000..2b60e96fb --- /dev/null +++ b/docs/changelog/2787.doc.rst @@ -0,0 +1 @@ +Fix a grammatical typo in docs/user_guide.rst. diff --git a/docs/user_guide.rst b/docs/user_guide.rst index 2a15ccacc..9a221feeb 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -48,7 +48,7 @@ The configuration is split into two type of configuration: core settings are hos environment settings hosted under ``testenv:``. Under the core section we define that this project has two run environments named ``format`` and ``py310`` respectively (we use the ``envlist`` configuration key to do so). -Then we define separately what should the formatting environment (``testenv:format`` section) and the test environment +Then we define separately the formatting environment (``testenv:format`` section) and the test environment (``testenv:py310`` section). For example to format the project we: - add a description (visible when you type ``tox list`` into the command line),