From 2ce16fd82251c5c4c39b884ad15c62b28c6a7ef2 Mon Sep 17 00:00:00 2001 From: adisbladis Date: Thu, 6 Jan 2022 05:49:43 +1300 Subject: [PATCH] README: Document new editablePackageSources behaviour where develop=true --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f55af4d..8320280 100644 --- a/README.md +++ b/README.md @@ -74,7 +74,7 @@ Creates an environment that provides a Python interpreter along with all depende - **poetrylock**: `poetry.lock` file path (_default_: `projectDir + "/poetry.lock"`). - **overrides**: Python overrides to apply (_default_: `[defaultPoetryOverrides]`). - **python**: The Python interpreter to use (_default:_ `pkgs.python3`). -- **editablePackageSources**: A mapping from package name to source directory, these will be installed in editable mode (_default:_ `{}`). +- **editablePackageSources**: A mapping from package name to source directory, these will be installed in editable mode. Note that path dependencies with `develop = true` will be installed in editable mode unless explicitly passed to `editablePackageSources` as `null`. (_default:_ `{}`). - **extraPackages**: A function taking a Python package set and returning a list of extra packages to include in the environment. This is intended for packages deliberately not added to `pyproject.toml` that you still want to include. An example of such a package may be `pip`. (_default:_ `(ps: [ ])`). #### Example