From 8aee217ba6f33447967d6d223ca7394d56d356d5 Mon Sep 17 00:00:00 2001 From: Sergey Matvienko Date: Tue, 3 Jan 2023 17:27:40 +0200 Subject: [PATCH 1/2] Add clarifications for `virtualenvs.path` settings --- docs/configuration.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index 719f7f10d95..ae7f2ad4c18 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -356,6 +356,13 @@ Applies on virtualenv creation. Directory where virtual environments will be created. +{{% note %}} +Please note that this is a global variable and it should not be used as a local configuration, as you may get unpredicted behaviour. +{{% /note %}} +{{% note %}} +If you want to have a virtual environment close to your project, check the `virtualenvs.in-project` settings. +{{% /note %}} + ### `virtualenvs.prefer-active-python` (experimental) **Type**: `boolean` From 4f71eb5e8557c006f61cbf87a55c600dc202fa92 Mon Sep 17 00:00:00 2001 From: Sergey Matvienko Date: Tue, 3 Jan 2023 21:56:32 +0200 Subject: [PATCH 2/2] Update of the note --- docs/configuration.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index ae7f2ad4c18..af537772277 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -357,10 +357,7 @@ Applies on virtualenv creation. Directory where virtual environments will be created. {{% note %}} -Please note that this is a global variable and it should not be used as a local configuration, as you may get unpredicted behaviour. -{{% /note %}} -{{% note %}} -If you want to have a virtual environment close to your project, check the `virtualenvs.in-project` settings. +This setting controls the global virtual environment storage path. It most likely will not be useful at the local level. To store virtual environments in the project root, see `virtualenvs.in-project`. {{% /note %}} ### `virtualenvs.prefer-active-python` (experimental)