From e65ffb24bb04cca338ff4200c8d15d5be69427a4 Mon Sep 17 00:00:00 2001 From: Brad Warren Date: Fri, 16 Jul 2021 15:18:43 -0700 Subject: [PATCH] no dummies --- certbot/docs/contributing.rst | 14 +++++++------- tools/pinning/DESIGN.md | 8 ++++---- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/certbot/docs/contributing.rst b/certbot/docs/contributing.rst index 40804b917..d00823e83 100644 --- a/certbot/docs/contributing.rst +++ b/certbot/docs/contributing.rst @@ -599,13 +599,13 @@ Updating dependency versions ``tools/requirements.txt`` and ``tools/oldest_constraints.txt`` can be updated using ``tools/pinning/current/repin.sh`` and ``tools/pinning/oldest/repin.sh`` respectively. This works by using ``poetry`` to generate pinnings based on a -dummy Poetry project defined by the ``pyproject.toml`` file in the same -directory as the script. In many cases, you can just run the script to generate -updated dependencies, however, if you need to pin back packages or unpin -packages that were previously restricted to an older version, you will need to -modify the ``pyproject.toml`` file. The syntax used by this file is described -at https://python-poetry.org/docs/pyproject/ and how dependencies are specified -in this file is further described at +Poetry project defined by the ``pyproject.toml`` file in the same directory as +the script. In many cases, you can just run the script to generate updated +dependencies, however, if you need to pin back packages or unpin packages that +were previously restricted to an older version, you will need to modify the +``pyproject.toml`` file. The syntax used by this file is described at +https://python-poetry.org/docs/pyproject/ and how dependencies are specified in +this file is further described at https://python-poetry.org/docs/dependency-specification/. If you want to learn more about the design used here, see diff --git a/tools/pinning/DESIGN.md b/tools/pinning/DESIGN.md index 456a0891d..e8b2664bb 100644 --- a/tools/pinning/DESIGN.md +++ b/tools/pinning/DESIGN.md @@ -64,10 +64,10 @@ pinnings. Under `current` and `oldest`, there are two files as of writing this. One is a pyproject.toml file for use with [Poetry](https://python-poetry.org/) while the other is a script that can be run to regenerate pinnings. The -pyproject.toml file defines a dummy Python package that depends on everything -we want to pin. This file largely just depends on our own local packages, -however, extra dependencies can be declared to further constrain package -versions or to declare additional dependencies. +pyproject.toml file defines a Python package that depends on everything we want +to pin. This file largely just depends on our own local packages, however, +extra dependencies can be declared to further constrain package versions or to +declare additional dependencies. The reason we use Poetry is that it is somewhat unique among Python packaging tools in that when locking dependencies, it makes a best effort approach to do