Fix typos and other inconsistencies in comments, tests and CHANGELOG (#2070)

As found by a Claude Code review pass of docs/comments/tests.

Author: edmorley

.editorconfig

@@ -29,7 +29,7 @@ shell_variant = bash
 switch_case_indent = true
 
 # The setup-ruby GitHub Action creates this directory when caching is enabled, and if
-# its not ignored will cause false positives when running shfmt in the CI lint job.
+# it's not ignored will cause false positives when running shfmt in the CI lint job.
 [vendor/bundle/**]
 ignore = true
 

CHANGELOG.md

@@ -124,7 +124,7 @@
 ## [v318] - 2025-11-12
 
 - Improved the error message shown when a `.python-version` file uses an unsupported file encoding. ([#1958](https://github.com/heroku/heroku-buildpack-python/pull/1958))
-- Improved the error message shown when a `.python-version` or `runtime.txt` file contain an invalid Python version. ([#1958](https://github.com/heroku/heroku-buildpack-python/pull/1958))
+- Improved the error message shown when a `.python-version` or `runtime.txt` file contains an invalid Python version. ([#1958](https://github.com/heroku/heroku-buildpack-python/pull/1958))
 - Added support for commented lines in `runtime.txt`, for parity with `.python-version`. ([#1958](https://github.com/heroku/heroku-buildpack-python/pull/1958))
 
 ## [v317] - 2025-11-03
@@ -259,7 +259,7 @@
 ## [v292] - 2025-07-23
 
 - Updated Pipenv from 2024.0.1 to 2025.0.4. ([#1840](https://github.com/heroku/heroku-buildpack-python/pull/1840))
-- Fixed the way Pipenv is installed, so that it and its dependencies are installed into a separate virtual environment rather than same environment as the app. If your app inadvertently depended on Pipenv's internal dependencies, you will need to add those dependencies explicitly to your `Pipfile`. ([#1840](https://github.com/heroku/heroku-buildpack-python/pull/1840))
+- Fixed the way Pipenv is installed, so that it and its dependencies are installed into a separate virtual environment rather than the same environment as the app. If your app inadvertently depended on Pipenv's internal dependencies, you will need to add those dependencies explicitly to your `Pipfile`. ([#1840](https://github.com/heroku/heroku-buildpack-python/pull/1840))
 - Stopped installing pip when Pipenv is the chosen package manager. ([#1840](https://github.com/heroku/heroku-buildpack-python/pull/1840))
 - The build cache is now cleared when using Pipenv if the contents of `Pipfile.lock` has changed since the last build. This is required to work around Pipenv not uninstalling packages when they are removed from the lockfile. ([#1840](https://github.com/heroku/heroku-buildpack-python/pull/1840))
 - The build now errors when using Pipenv without its lockfile (`Pipfile.lock`). This replaces the warning displayed since November 2024. ([#1833](https://github.com/heroku/heroku-buildpack-python/pull/1833))
@@ -555,7 +555,7 @@
 
 ## [v243] - 2024-02-07
 
-- Added support for Python 3.11.8 and 3.12.2. ([#1538](https://github.com/heroku/heroku-buildpack-python/pull/1538)).
+- Added support for Python 3.11.8 and 3.12.2. ([#1538](https://github.com/heroku/heroku-buildpack-python/pull/1538))
 - Changed the default Python version for new apps from 3.12.1 to 3.12.2. ([#1538](https://github.com/heroku/heroku-buildpack-python/pull/1538))
 
 ## [v242] - 2024-01-11
@@ -566,8 +566,8 @@
 
 ## [v241] - 2023-12-08
 
-- Changed the default Python version for new apps from Python 3.11 to Python 3.12. ([#1516](https://github.com/heroku/heroku-buildpack-python/pull/1516)).
-- Added support for Python 3.11.7 and 3.12.1. ([#1517](https://github.com/heroku/heroku-buildpack-python/pull/1517) and [#1518](https://github.com/heroku/heroku-buildpack-python/pull/1518)).
+- Changed the default Python version for new apps from Python 3.11 to Python 3.12. ([#1516](https://github.com/heroku/heroku-buildpack-python/pull/1516))
+- Added support for Python 3.11.7 and 3.12.1. ([#1517](https://github.com/heroku/heroku-buildpack-python/pull/1517) and [#1518](https://github.com/heroku/heroku-buildpack-python/pull/1518))
 - Added a deprecation warning for Python 3.8. ([#1515](https://github.com/heroku/heroku-buildpack-python/pull/1515))
 
 ## [v240] - 2023-11-30
@@ -1443,7 +1443,7 @@ Updated pip and Setuptools.
 
 Added warnings for lack of Procfile.
 
-## v72 - 2015-12-07
+## v73 - 2015-12-07
 
 Updated default Python to 2.7.11.
 

bin/compile

@@ -3,7 +3,7 @@
 # See: https://devcenter.heroku.com/articles/buildpack-api
 
 # We use `errtrace` and `inherit_errexit` to ensure the ERR trap and exit on error behaviour
-# propagates to buildpack functions run in subshells, such when using command substitutions.
+# propagates to buildpack functions run in subshells, such as when using command substitutions.
 set -eu -o pipefail -o errtrace
 shopt -s inherit_errexit
 
@@ -56,7 +56,6 @@ export BUILD_DIR CACHE_DIR ENV_DIR
 unset PYTHONHOME PYTHONPATH
 
 # Import the warnings script, which contains the `pip install` user warning mechanisms
-# (mentioned and explained above)
 source "${BUILDPACK_DIR}/bin/warnings"
 
 # Make the directory in which we will create symlinks from the temporary build directory
@@ -76,7 +75,7 @@ python_home='/app/.heroku/python'
 # using `/app` paths which will still work at run-time after relocation. Amongst other things, this
 # ensures that the shebang lines in the entrypoint scripts of installed packages are correct.
 export PATH="/app/.heroku/python/bin:${PATH}"
-# Tell Python to not buffer it's stdin/stdout.
+# Tell Python to not buffer its stdin/stdout.
 export PYTHONUNBUFFERED=1
 # Ensure Python uses a Unicode locale, to prevent the issues described in:
 # https://github.com/docker-library/python/pull/570
@@ -266,7 +265,7 @@ EOT
 #
 # In addition to ensuring dependencies work for subsequent buildpacks and at runtime, they must also
 # work for cached rebuilds. Most package managers will reinstall editable dependencies regardless on
-# next install, which means we can avoid having to rewrite paths on cache restore from the old build
+# the next install, which means we can avoid having to rewrite paths on cache restore from the old build
 # directory to the new location (`/tmp/build_<different-hash>`). However, Pipenv has a bug when using
 # PEP660 style editable VCS dependencies where it won't reinstall if it's missing (or in our case, the
 # path has changed), which means we must make sure that VCS src paths stored in the cache do use the

builds/build_python_runtime.sh

@@ -104,7 +104,7 @@ CONFIGURE_OPTS=(
 	#   and not the static library (such as `pycall.rb` or `PyO3`).
 	# - More consistent with the official Python Docker images and other distributions.
 	#
-	# Shared builds are slower unless `no-semantic-interposition`and LTO is used,
+	# Shared builds are slower unless `no-semantic-interposition` and LTO are used,
 	# however, as of Python 3.10 `no-semantic-interposition` is enabled by default:
 	# https://fedoraproject.org/wiki/Changes/PythonNoSemanticInterpositionSpeedup
 	# https://github.com/python/cpython/issues/83161

builds/test_python_runtime.sh

@@ -88,7 +88,7 @@ if "${INSTALL_DIR}/bin/python3" -c "import $(
 	IFS=,
 	echo "${optional_stdlib_modules[*]}"
 )"; then
-	echo "Successful imported: ${optional_stdlib_modules[*]}"
+	echo "Successfully imported: ${optional_stdlib_modules[*]}"
 else
 	abort "The above optional stdlib module failed to import! Check the compile logs to see if it was skipped due to missing libraries/headers."
 fi

lib/cache.sh

@@ -181,7 +181,7 @@ function cache::save() {
 	# but not Heroku CI or build-in-app-dir. Ideally we would be able to use `--reflink=auto` here
 	# (which would avoid the need for a conditional and also mean accidental edits by users in later
 	# buildpacks to one location doesn't affect the other), however, with the current filesystems
-	# used in production benchmarking showed `--reflinks=auto` was much slower than hardlinks.
+	# used in production benchmarking showed `--reflink=auto` was much slower than hardlinks.
 	if [[ "${build_dir_filesystem}" == "${cache_dir_filesystem}" ]]; then
 		local additional_copy_args=(--link)
 	else

lib/hooks.sh

@@ -4,7 +4,7 @@
 # however, it helps Shellcheck realise the options under which these functions will run.
 set -euo pipefail
 
-# Used to run the `bin/pre_compile` and `bin/post_compile`s scripts if found in the app source,
+# Used to run the `bin/pre_compile` and `bin/post_compile` scripts if found in the app source,
 # allowing for build customisation.
 function hooks::run_hook() {
 	local hook_name="${1}"

lib/python_version.sh

@@ -128,7 +128,7 @@ function python_version::read_requested_python_version() {
 		fi
 	fi
 
-	# Protect against unsupported (eg PyPy) or invalid versions being found in the cache metadata.
+	# Protect against unsupported (e.g. PyPy) or invalid versions being found in the cache metadata.
 	if [[ "${cached_python_full_version}" =~ ^${PYTHON_FULL_VERSION_REGEX}$ ]]; then
 		local cached_python_major_version="${cached_python_full_version%.*}"
 		version="${cached_python_major_version}"

lib/utils.sh

@@ -27,7 +27,7 @@ function utils::bundled_pip_module_path() {
 	# We have to use a glob since the bundled wheel filename contains the pip version, which differs
 	# between Python versions. We use compgen to avoid having to set nullglob, since there may be no
 	# matches in the case of a broken Python install. We also have to handle the case where there are
-	# multiple matching pip wheels, since in some versions of Python (eg 3.9.0) multiple versions of
+	# multiple matching pip wheels, since in some versions of Python (e.g. 3.9.0) multiple versions of
 	# pip were accidentally bundled upstream (we use tail since we want the newest pip version).
 	if bundled_pip_wheel="$(compgen -G "${bundled_wheels_dir}/pip-*.whl" | tail --lines=1)"; then
 		# The pip module exists inside the pip wheel (which is a zip file), however, Python can load

lib/uv.sh

@@ -25,7 +25,7 @@ function uv::install_uv() {
 		mkdir -p "${uv_dir}"
 
 		local gnu_arch
-		# eg: `x86_64` or `aarch64`.
+		# e.g.: `x86_64` or `aarch64`.
 		gnu_arch=$(arch)
 		local uv_url="https://releases.astral.sh/github/uv/releases/download/${UV_VERSION}/uv-${gnu_arch}-unknown-linux-gnu.tar.gz"