Skip to content

Commit ff9b5bb

Browse files
authored
expand doc description of data type
1 parent b9d4002 commit ff9b5bb

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

python/private/pypi/whl_library.bzl

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -619,7 +619,15 @@ attr makes `extra_pip_args` and `download_only` ignored.""",
619619
),
620620
"whl_patches": attr.label_keyed_string_dict(
621621
doc = """
622-
A label-keyed-string dict that has json.encode(struct([whls], patch_strip]) as values.
622+
A label-keyed-string dict with patch files as keys and json-strings as values.
623+
624+
The keys are labels to the patch file to apply.
625+
626+
The values describe what to apply the patch to and how to apply it.
627+
It is encoded as `json.encode(struct([whls], patch_strip])`,
628+
where `whls` is a `list[str`] of wheel filenames, and `patch_strip`
629+
is a number.
630+
623631
So it will look something like this:
624632
```
625633
"//path/to/package:my.patch": json.encode(struct(

0 commit comments

Comments
 (0)