Skip to content

Commit 6864dec

Browse files
committed
Update py_wheel docs
1 parent f6feca1 commit 6864dec

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

python/private/py_wheel.bzl

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,15 @@ _other_attrs = {
217217
),
218218
"strip_path_prefixes": attr.string_list(
219219
default = [],
220-
doc = "path prefixes to strip from files added to the generated package",
220+
doc = """\
221+
Path prefixes to strip from files added to the generated package.
222+
Prefixes are checked **in order** and only the **first match** will be used.
223+
224+
For example:
225+
+ `["foo", "foo/bar/baz"]` will strip `"foo/bar/baz/file.py"` to `"bar/baz/file.py"`
226+
+ `["foo/bar/baz", "foo"]` will strip `"foo/bar/baz/file.py"` to `"file.py"` and
227+
`"foo/file2.py"` to `"file2.py"`
228+
""",
221229
),
222230
"summary": attr.string(
223231
doc = "A one-line summary of what the distribution does",

0 commit comments

Comments
 (0)