Skip to content

Commit 0651747

Browse files
committed
refactor(masonry): indicate that escape_name is for generated wheels only
1 parent 23e40b6 commit 0651747

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

src/poetry/core/masonry/utils/helpers.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,8 @@ def escape_version(version: str) -> str:
2929

3030

3131
def escape_name(name: str) -> str:
32-
"""Escaped wheel name as specified in https://packaging.python.org/en/latest/specifications/binary-distribution-format/#escaping-and-unicode."""
32+
"""
33+
Escaped wheel name as specified in https://packaging.python.org/en/latest/specifications/binary-distribution-format/#escaping-and-unicode.
34+
This method should only be used for the generation of wheels, and not for the artifact package names.
35+
"""
3336
return re.sub(r"[-_.]+", "_", name, flags=re.UNICODE).lower()

0 commit comments

Comments
 (0)