Skip to content

Commit 3bc91bd

Browse files
committed
Adding documentation
This commit adds some documentation to the various extensions.
1 parent cd65748 commit 3bc91bd

File tree

3 files changed

+9
-3
lines changed

3 files changed

+9
-3
lines changed

python/extensions/pip.bzl

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,12 @@ def _pip_parse_ext_attrs():
7373
return attrs
7474

7575
pip = module_extension(
76+
doc = """\
77+
This extension is used to create a pip respository and create the various wheel libaries if
78+
provided in a requirements file.
79+
""",
7680
implementation = _pip_impl,
7781
tag_classes = {
7882
"parse": tag_class(attrs = _pip_parse_ext_attrs()),
7983
},
80-
)
84+
)

python/extensions/private/internal_deps.bzl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,9 @@ def _internal_deps_impl(module_ctx):
1717
install_coverage_deps()
1818

1919
internal_deps = module_extension(
20+
doc = "This extension to register internal rules_python dependecies.",
2021
implementation = _internal_deps_impl,
2122
tag_classes = {
2223
"install": tag_class(attrs = dict()),
2324
},
24-
)
25+
)

python/extensions/python.bzl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ def _python_impl(module_ctx):
4242
)
4343

4444
python = module_extension(
45+
doc = "Bzlmod extension that is used to register a Python toolchain.",
4546
implementation = _python_impl,
4647
tag_classes = {
4748
"toolchain": tag_class(
@@ -60,4 +61,4 @@ python = module_extension(
6061
},
6162
),
6263
},
63-
)
64+
)

0 commit comments

Comments
 (0)