PR#1225: Update guidelines/modules/ROOT/pages/Python.adoc - packaging-committee

Tomas Orsava • 2 years ago

11603c3

file modified

+7 -1

		`@@ -248,6 +248,12 @@`
		`https://www.python.org/dev/peps/pep-0503/#normalized-names[PEP 503],`
		and <<py_dist_name,the `+%{py_dist_name}+` macro>> 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 @@`
		`The Fedora package’s name SHOULD contain`
		`the <<Canonical project name>>.`
		`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,`

Explain how canonical names are created.

We ran into the canonical name not being very clear in https://bugzilla.redhat.com/show_bug.cgi?id=2139873.

I think that we might want to do some more refactoring of this text, but this addition is great on its own. +1 from me.

I've amended your commit with:

-as the name of the main importable module, in lowercase
+as the name of the main importable module,
+in lowercase,

This changes whitespace to follow semantic linebreaks and adds one extra comma that felt better for me.

I've also amended the commit message not to contain the Update guidelines/modules/ROOT/pages/Python.adoc line.

And since I have no provenpackager powers for pagure.io, I cannot push to your branch: https://pagure.io/packaging-committee/pull-request/1226

Pull-Request has been closed by churchyard

2 years ago

Assignee

None

Tags

No Tags