From 0fe0b78a9f77391b8df8c94527bef8ecc8fff407 Mon Sep 17 00:00:00 2001 From: Emmanuel Arias Date: Thu, 13 Jan 2022 12:52:18 -0300 Subject: [PATCH 1/2] Improve on configuration file docs section To avoid confusions the part of that "the configuration file can be locate on your tests folder" is removed. --- changelog/9505.trivial.rst | 2 ++ doc/en/reference/customize.rst | 3 +-- 2 files changed, 3 insertions(+), 2 deletions(-) create mode 100644 changelog/9505.trivial.rst diff --git a/changelog/9505.trivial.rst b/changelog/9505.trivial.rst new file mode 100644 index 00000000000..51386c226bf --- /dev/null +++ b/changelog/9505.trivial.rst @@ -0,0 +1,2 @@ +Clarify where the configuration files are located. To avoid confusions documentation mentions +that configuration file is located in the root of the repository. diff --git a/doc/en/reference/customize.rst b/doc/en/reference/customize.rst index 22ce24b31e0..626cbaf1709 100644 --- a/doc/en/reference/customize.rst +++ b/doc/en/reference/customize.rst @@ -20,8 +20,7 @@ Configuration file formats -------------------------- Many :ref:`pytest settings ` can be set in a *configuration file*, which -by convention resides on the root of your repository or in your -tests folder. +by convention resides on the root of your repository. A quick example of the configuration files supported by pytest: From 5c2d752e74dbc0e5c39233c0584129709d411112 Mon Sep 17 00:00:00 2001 From: Emmanuel Arias Date: Thu, 13 Jan 2022 13:29:08 -0300 Subject: [PATCH 2/2] improve docs --- doc/en/reference/customize.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/en/reference/customize.rst b/doc/en/reference/customize.rst index 626cbaf1709..fe10ca066b2 100644 --- a/doc/en/reference/customize.rst +++ b/doc/en/reference/customize.rst @@ -20,7 +20,7 @@ Configuration file formats -------------------------- Many :ref:`pytest settings ` can be set in a *configuration file*, which -by convention resides on the root of your repository. +by convention resides in the root directory of your repository. A quick example of the configuration files supported by pytest: