From 11603c3d3a4ddb2ad5fccc8c4a198e99313a63d5 Mon Sep 17 00:00:00 2001 From: Tomas Orsava Date: Nov 04 2022 14:57:04 +0000 Subject: Update guidelines/modules/ROOT/pages/Python.adoc Explain how canonical names are created. --- diff --git a/guidelines/modules/ROOT/pages/Python.adoc b/guidelines/modules/ROOT/pages/Python.adoc index 721be9a..f5caccd 100644 --- a/guidelines/modules/ROOT/pages/Python.adoc +++ b/guidelines/modules/ROOT/pages/Python.adoc @@ -248,6 +248,12 @@ This normalization is defined in https://www.python.org/dev/peps/pep-0503/#normalized-names[PEP 503], and <> implements it for Fedora packaging. +The canonical name is obtained by switching the project name to lower case +and converting all runs of non-alphanumeric characters to single “-” characters. +Example: “The $$$ Tree” becomes “the-tree”. + + + Elsewhere in this text, the metavariable `+DISTNAME+` refers to the canonical form of the project name. @@ -284,7 +290,7 @@ A source package containing primarily a _Python library_ The Fedora package’s name *SHOULD* contain the <>. If possible, the project name *SHOULD* be the same -as the name of the main importable module, +as the name of the main importable module, in lowercase with underscores (`+_+`) replaced by dashes (`+-+`). If the importable module name and the project name do not match,