Skip to content

Commit c4b08ad

Browse files
committed
add docs and a note
1 parent 7348c16 commit c4b08ad

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

python/private/pypi/pep508_platform.bzl

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,19 @@
1616
"""
1717

1818
def platform(*, abi = None, os = None, arch = None):
19+
"""platform returns a struct for the platform.
20+
21+
Args:
22+
abi: {type}`str | None` the target ABI, e.g. `"cp39"`.
23+
os: {type}`str | None` the target os, e.g. `"linux"`.
24+
arch: {type}`str | None` the target CPU, e.g. `"aarch64"`.
25+
26+
Returns:
27+
A struct.
28+
"""
29+
30+
# Note, this is used a lot as a key in dictionaries, so it cannot contain
31+
# methods.
1932
return struct(
2033
abi = abi,
2134
os = os,

0 commit comments

Comments
 (0)