Skip to content

Commit c7cc067

Browse files
djcopleylwasser
andcommitted
update documentation wording
Co-authored-by: Leah Wasser <[email protected]>
1 parent afa8036 commit c7cc067

File tree

2 files changed

+5
-9
lines changed

2 files changed

+5
-9
lines changed

docs/config/environment/advanced.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ hatch run test:cov
129129

130130
## Dependency Groups
131131

132-
Environments can use [PEP 735](https://peps.python.org/pep-0735/) dependency groups with the `dependency-groups` option:
132+
Environments can use [PEP 735](https://peps.python.org/pep-0735/) dependency groups using the environment `dependency-groups` array:
133133

134134
```toml config-example
135135
[dependency-groups]
@@ -159,7 +159,7 @@ dependency-groups = ["lint"]
159159
dependency-groups = ["dev"]
160160
```
161161

162-
The `dependency-groups` option specifies which PEP 735 dependency groups to include in the environment's dependencies. This is particularly useful for organizing related dependencies and including them in appropriate environments.
162+
The `dependency-groups` array specifies which dependency groups to include in the environment's dependencies. This is particularly useful for organizing related dependencies and including them in appropriate environments.
163163

164164
### Combining with Other Dependencies
165165

@@ -184,7 +184,6 @@ dependency-groups = ["test"]
184184
dependencies = [
185185
"coverage[toml]>=7.0.0",
186186
]
187-
# Project dependencies will be included if not skip-install and in dev-mode
188187
```
189188

190189
In this example, the test environment would include:

docs/config/environment/overview.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,9 @@ features = [
105105

106106
### Dependency Groups
107107

108-
You can include [PEP 735](https://peps.python.org/pep-0735/) dependency groups in your environments using the `dependency-groups` option:
108+
[Dependency groups](https://packaging.python.org/en/latest/specifications/dependency-groups/#dependency-groups) (standardized in PEP 735) provide a uniform way to organize related development dependencies. See [advanced usage](advanced.md#dependency-groups) for more details on dependency group features like including other groups.
109+
110+
You can include dependency-groups in your hatch environments using the `[dependency-groups]` array:
109111

110112
```toml config-example
111113
[dependency-groups]
@@ -120,11 +122,6 @@ dependency-groups = [
120122
]
121123
```
122124

123-
Dependency groups provide a standardized way to organize related dependencies and can be shared across different build systems. See [advanced usage](advanced.md#dependency-groups) for more details on dependency group features like including other groups.
124-
125-
!!! note
126-
Unlike features which affect how the project itself is installed, dependency groups are separate dependencies that are installed alongside the project.
127-
128125
### Dev mode
129126

130127
By default, environments will always reflect the current state of your project on disk, for example, by installing it in editable mode in a Python environment. Set `dev-mode` to `false` to disable this behavior and have your project installed only upon creation of a new environment. From then on, you need to manage your project installation manually.

0 commit comments

Comments
 (0)