From 32b0d042f69049d22769cc6616aac1aae8dbdf01 Mon Sep 17 00:00:00 2001 From: Oliver Bertram Date: Thu, 7 Nov 2024 08:53:42 +0100 Subject: [PATCH] fix docs: set correct default values for the 'groups' parameter of mkPoetryApplication and mkPoetryEnv --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c79caa162..10a4568bc 100644 --- a/README.md +++ b/README.md @@ -158,7 +158,7 @@ Creates a Python application using the Python interpreter specified based on the - **meta**: application [meta](https://nixos.org/nixpkgs/manual/#chap-meta) data (_default:_ `{}`). - **python**: The Python interpreter to use (_default:_ `pkgs.python3`). - **preferWheels** : Use wheels rather than sdist as much as possible (_default_: `false`). -- **groups**: Which Poetry 1.2.0+ dependency groups to install (_default_: `[ ]`). +- **groups**: Which Poetry 1.2.0+ dependency groups to install (_default_: `[ "main" ]`). - **checkGroups**: Which Poetry 1.2.0+ dependency groups to install (independently of **groups**) to run unit tests (_default_: `[ "dev" ]`). - **extras**: Which Poetry `extras` to install (_default_: `[ "*" ]`, all extras). @@ -216,7 +216,7 @@ Creates an environment that provides a Python interpreter along with all depende - **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: [ ])`). - **preferWheels** : Use wheels rather than sdist as much as possible (_default_: `false`). -- **groups**: Which Poetry 1.2.0+ dependency groups to install (_default_: `[ "dev" ]`). +- **groups**: Which Poetry 1.2.0+ dependency groups to install (_default_: `[ "main" "dev" ]`). - **checkGroups**: Which Poetry 1.2.0+ dependency groups to install (independently of **groups**) to run unit tests (_default_: `[ "dev" ]`). - **extras**: Which Poetry `extras` to install (_default_: `[ "*" ]`, all extras).