Skip to content

Commit

Permalink
Merge pull request #1374 from takeda/checkGroups-doc
Browse files Browse the repository at this point in the history
chore: documentation for checkGroups (fixes #1335)
  • Loading branch information
adisbladis authored Oct 26, 2023
2 parents 8f2c483 + 9543530 commit 2d34ce9
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ Creates a Python application using the Python interpreter specified based on the
- **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_: `[ ]`).
- **checkGroups**: Which Poetry 1.2.0+ dependency groups to run unit tests (_default_: `[ "dev" ]`).
- **extras**: Which Poetry `extras` to install (_default_: `[ "*" ]`, all extras).

Other attributes are passed through to `buildPythonApplication`.
Expand Down Expand Up @@ -98,6 +99,7 @@ Creates an environment that provides a Python interpreter along with all depende
- **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" ]`).
- **checkGroups**: Which Poetry 1.2.0+ dependency groups to run unit tests (_default_: `[ "dev" ]`).
- **extras**: Which Poetry `extras` to install (_default_: `[ "*" ]`, all extras).

#### Example
Expand Down Expand Up @@ -163,6 +165,7 @@ Creates an attribute set of the shape `{ python, poetryPackages, pyProject, poet
- **editablePackageSources**: A mapping from package name to source directory, these will be installed in editable mode (_default:_ `{}`).
- **preferWheels** : Use wheels rather than sdist as much as possible (_default_: `false`).
- **groups**: Which Poetry 1.2.0+ dependency groups to install (_default_: `[ ]`).
- **checkGroups**: Which Poetry 1.2.0+ dependency groups to run unit tests (_default_: `[ "dev" ]`).
- **extras**: Which Poetry `extras` to install (_default_: `[ "*" ]`, all extras).

#### Example
Expand Down

0 comments on commit 2d34ce9

Please sign in to comment.