From 14b621edeabe961880b4ef269e60488f08a149cc Mon Sep 17 00:00:00 2001 From: Tomas Orsava Date: Nov 08 2022 23:21:11 +0000 Subject: Explain how Python canonical names are created --- diff --git a/guidelines/modules/ROOT/pages/Python.adoc b/guidelines/modules/ROOT/pages/Python.adoc index 721be9a..70bea4c 100644 --- a/guidelines/modules/ROOT/pages/Python.adoc +++ b/guidelines/modules/ROOT/pages/Python.adoc @@ -248,6 +248,9 @@ 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. @@ -285,6 +288,7 @@ 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, +in lowercase, with underscores (`+_+`) replaced by dashes (`+-+`). If the importable module name and the project name do not match,