script improvements

tools/pinning/common/export-pinned-dependencies.sh

@@ -3,8 +3,14 @@
 # for use with poetry and generates and prints the pinned dependencies of that
 # file. Any dependencies on acme or those referencing certbot will be removed
 # from the output. The exported requirements are printed to stdout.
+#
+# For example, if a directory containing a pyproject.toml file for poetry is at
+# ../current, you could activate Certbot's developer environment and then run a
+# command like the following to generate requirements.txt for that environment:
+#   ./export-pinned-dependencies.sh ../current > requirements.txt
 set -euo pipefail
 
+# If this script wasn't given a command line argument, print usage and exit.
 if [ -z ${1+x} ]; then
     echo "Usage:" >&2
     echo "$0 PYPROJECT_TOML_DIRECTORY" >&2

tools/pinning/current/repin.sh

@@ -1,7 +1,8 @@
 #!/bin/bash
 # This script accepts no arguments and automates the process of updating
-# Certbot's dependencies. Dependencies can be pinned to older versions by
-# modifying pyproject.toml in the same directory as this file.
+# Certbot's dependencies including automatically updating the correct file.
+# Dependencies can be pinned to older versions by modifying pyproject.toml in
+# the same directory as this file.
 set -euo pipefail
 
 WORK_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"

tools/pinning/oldest/repin.sh

@@ -1,8 +1,8 @@
 #!/bin/bash
 # This script accepts no arguments and automates the process of updating
-# Certbot's dependencies used for our "oldest" tests. Dependencies can be
-# pinned to older versions by modifying pyproject.toml in the same directory as
-# this file.
+# Certbot's dependencies including automatically updating the correct file.
+# Dependencies can be pinned to older versions by modifying pyproject.toml in
+# the same directory as this file.
 set -euo pipefail
 
 WORK_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null && pwd )"