From 09d78f7980fbd86a630a0016068775f222171090 Mon Sep 17 00:00:00 2001 From: Agriya Khetarpal <74401230+agriyakhetarpal@users.noreply.github.com> Date: Sat, 13 Jan 2024 00:58:31 +0530 Subject: [PATCH] Update file extensions for SDists and wheels MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit A minor documentation fix, this section referred to the wheel as a `.tar.gz` file while it isn't – it is fairly known that it is a `.zip` file. I added the correct file extension for the SDist in the point above it, just for the sake of clarity. --- docs/pages/guides/packaging_classic.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/pages/guides/packaging_classic.md b/docs/pages/guides/packaging_classic.md index f59a0132..165952cd 100644 --- a/docs/pages/guides/packaging_classic.md +++ b/docs/pages/guides/packaging_classic.md @@ -403,15 +403,15 @@ Python packaging goes through a 3-stage procedure if you have the above recommended `pyproject.toml` file. If you type `pip install .`, then 1. Source is processed to make an SDist (in a virtual environment mandated by - pyproject.toml). + pyproject.toml). This SDist bears a `.tar.gz` file format. 2. SDist is processed to make a wheel (same virtual environment). 3. The wheel is installed. The wheel does _not_ contain `setup.*`, `pyproject.toml`, or other build code. -It simply is a `.tar.gz` file that is named `.whl` and has a simple mapping of -directories to installation paths and a generic metadata format. "Installing" -really is just copying files around, and pip also pre-compiles some bytecode for -you while doing so. +It simply is a `.zip` format archive with the `.whl` suffix and has a simple +mapping of directories to installation paths and a generic metadata format. +"Installing" really is just copying files around, and pip also pre-compiles some +bytecode for you while doing so. If you don't have a `MANIFEST.in`, the "legacy" build procedure will skip the SDist step, making it possible for a development build to work while a published