Skip to content

Commit d166d47

Browse files
committed
chore: improve the docs
1 parent e232a5d commit d166d47

File tree

7 files changed

+14
-12
lines changed

7 files changed

+14
-12
lines changed

examples/bzlmod/MODULE.bazel.lock

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/pip_parse_vendored/requirements.bzl

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
@generated by rules_python pip_parse repository rule.
44
"""
55

6-
load("@rules_python//python:pip.bzl", "pip_utils")
7-
load("@rules_python//python/pip_install:pip_repository.bzl", "group_library", "whl_library")
6+
load("@rules_python//python:pip.bzl", "group_library", "pip_utils", "whl_library")
87

98
all_requirements = [
109
"@my_project_pip_deps_vendored_certifi//:pkg",

gazelle/manifest/defs.bzl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ def gazelle_python_manifest(
3939
manifest, meaning testing it is just as expensive as generating it,
4040
but modifying it is much less likely to result in a merge conflict.
4141
pip_repository_name: the name of the pip_install or pip_repository target.
42-
pip_deps_repository_name: deprecated - the old pip_install target name.
42+
pip_deps_repository_name: deprecated - the old {bzl:obj}`pip_parse` target name.
4343
manifest: the Gazelle manifest file.
4444
defaults to the same value as manifest.
4545
**kwargs: other bazel attributes passed to the generate and test targets

gazelle/manifest/generate/generate.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ func main() {
5555
&pipRepositoryName,
5656
"pip-repository-name",
5757
"",
58-
"The name of the pip_install or pip_repository target.")
58+
"The name of the pip_parse or pip.parse target.")
5959
flag.StringVar(
6060
&modulesMappingPath,
6161
"modules-mapping",

internal_setup.bzl

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ def rules_python_internal_setup():
4242
python_versions = sorted(TOOL_VERSIONS.keys()),
4343
)
4444

45-
# Because we don't use the pip_install rule, we have to call this to fetch its deps
4645
pypi_deps()
4746

4847
bazel_skylib_workspace()

python/extensions/pip.bzl

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,13 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
"pip module extension for use with bzlmod"
15+
"""
16+
This is the successor to {bzl:obj}`pip_parse` for including third party PyPI dependencies into your bazel module using `bzlmod`.
17+
18+
:::{seealso}
19+
For user documentation see the [PyPI dependencies section](pypi-dependencies).
20+
:::
21+
"""
1622

1723
load("//python/private/pypi:pip.bzl", _pip = "pip")
1824

python/private/pypi/extension.bzl

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -764,8 +764,7 @@ the BUILD files for wheels.
764764
attrs = _pip_parse_ext_attrs(),
765765
doc = """\
766766
This tag class is used to create a pip hub and all of the spokes that are part of that hub.
767-
This tag class reuses most of the pip attributes that are found in
768-
@rules_python//python/pip_install:pip_repository.bzl.
767+
This tag class reuses most of the attributes found in {bzl:obj}`pip_parse`.
769768
The exception is it does not use the arg 'repo_prefix'. We set the repository
770769
prefix for the user and the alias arg is always True in bzlmod.
771770
""",
@@ -814,8 +813,7 @@ the BUILD files for wheels.
814813
),
815814
doc = """\
816815
This tag class is used to create a pypi hub and all of the spokes that are part of that hub.
817-
This tag class reuses most of the pypi attributes that are found in
818-
@rules_python//python/pip_install:pip_repository.bzl.
816+
This tag class reuses most of the attributes found in {bzl:obj}`pip_parse`.
819817
The exception is it does not use the arg 'repo_prefix'. We set the repository
820818
prefix for the user and the alias arg is always True in bzlmod.
821819
""",

0 commit comments

Comments
 (0)