From 2341590e1c1475dd43ee9989c91c7f88979fb911 Mon Sep 17 00:00:00 2001 From: Jean Abou Samra Date: Sat, 23 Dec 2023 00:02:26 +0100 Subject: [PATCH] Address @pradyunsg's review --- source/specifications/core-metadata.rst | 3 ++- source/specifications/name-normalization.rst | 18 +++++++++--------- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/source/specifications/core-metadata.rst b/source/specifications/core-metadata.rst index 6b5efd13a..5248c7122 100644 --- a/source/specifications/core-metadata.rst +++ b/source/specifications/core-metadata.rst @@ -76,7 +76,8 @@ Name Added restrictions on format from the :ref:`name grammar `. The name of the distribution. The name field is the primary identifier for a -distribution. It must conform to the :ref:`package name grammar `. +distribution. It must conform to the :ref:`name format specification +`. Example:: diff --git a/source/specifications/name-normalization.rst b/source/specifications/name-normalization.rst index fb6d22a09..227b9692c 100644 --- a/source/specifications/name-normalization.rst +++ b/source/specifications/name-normalization.rst @@ -1,16 +1,16 @@ -====================================== -Package name grammar and normalization -====================================== +======================= +Names and normalization +======================= -Project names obey a restricted format, and are "normalized" for use in various -contexts. This document describes what the valid project names are, and how -project names should be normalized. +This specification defines the format that names for packages and extras are +required to follow. It also describes how to normalize them, which should be +done before lookups and comparisons. -.. _name-grammar: +.. _name-format: -Name grammar -============ +Name format +=========== A valid name consists only of ASCII letters and numbers, period, underscore and hyphen. It must start and end with a letter or number.