@@ -189,7 +189,7 @@ Importance of pinned dependencies
189189
190190.. note ::
191191
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
193193 `dependency version range <https://dev.docs.pyansys.com/how-to/packaging.html#dependency-version-range >`_.
194194 of the project itself.
195195
@@ -202,11 +202,11 @@ failures without any code change. In fact, problems can occur at different level
202202 in API behavior, deprecations, or regressions, affecting production code.
203203- Test failures: A minor update of a testing library could introduce breaking changes or
204204 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
206206 subtle or breaking changes, like new warnings treated as errors or theme updates breaking
207207 rendering, causing your docs build to fail.
208208
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
210210workflows are reliable and predictable.
211211
212212Additionally, having a complete, pinned set of dependencies is very useful for users and
@@ -234,13 +234,13 @@ the project with `tests` dependencies:
234234 poetry install --with tests
235235
236236 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
238238``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
240240``poetry.lock `` file, the requirements file does not include the variations for each installation
241241target. To create a requirements file with a specific extra, you can use the ``--extras `` option.
242242For 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,
244244you can use the following command in your CI workflow to install the project with `tests `
245245dependencies:
246246
0 commit comments