@@ -189,7 +189,7 @@ Importance of pinned dependencies
189
189
190
190
.. note ::
191
191
192
- This guidance applies to CI workflows. It does apply to the
192
+ This guidance applies to CI workflows. It does not apply to the
193
193
`dependency version range <https://dev.docs.pyansys.com/how-to/packaging.html#dependency-version-range >`_.
194
194
of the project itself.
195
195
@@ -202,11 +202,11 @@ failures without any code change. In fact, problems can occur at different level
202
202
in API behavior, deprecations, or regressions, affecting production code.
203
203
- Test failures: A minor update of a testing library could introduce breaking changes or
204
204
modify test behavior, causing false negatives or false positives.
205
- - Documentation build breaks : A documentation generator like `Sphinx ` might introduce
205
+ - Documentation build failures : A documentation generator like `Sphinx ` might introduce
206
206
subtle or breaking changes, like new warnings treated as errors or theme updates breaking
207
207
rendering, causing your docs build to fail.
208
208
209
- Pinning dependencies avoid these issues by freezing exact versions and ensure that CI
209
+ Pinning dependencies helps to avoid these issues by freezing exact versions and ensuring that CI
210
210
workflows are reliable and predictable.
211
211
212
212
Additionally, having a complete, pinned set of dependencies is very useful for users and
@@ -234,13 +234,13 @@ the project with `tests` dependencies:
234
234
poetry install --with tests
235
235
236
236
If your project uses `flit ` or `hatch `, you can use `uv <https://github.com/astral-sh/uv >`_
237
- to fastly resolve the dependencies and generate a requirements file. You can use the
237
+ to resolve the dependencies and generate a requirements file. You can use the
238
238
``uv pip compile -o requirements.txt pyproject.toml `` command to generate a ``requirements.txt ``
239
- file with the main dependencies defined in your project. Note that, contrary to the
239
+ file with the main dependencies defined in your project. Note that, unlike the
240
240
``poetry.lock `` file, the requirements file does not include the variations for each installation
241
241
target. To create a requirements file with a specific extra, you can use the ``--extras `` option.
242
242
For example, you can create a requirement file with the `tests ` extra by running the
243
- ``uv pip compile --extra tests -o requirements-tests.txt pyproject.toml ``. Once the file created,
243
+ ``uv pip compile --extra tests -o requirements-tests.txt pyproject.toml ``. Once the file has been created,
244
244
you can use the following command in your CI workflow to install the project with `tests `
245
245
dependencies:
246
246
0 commit comments