Skip to content

Commit

Permalink
refactor(visibility)!: limit visibility of an internal library (#1490)
Browse files Browse the repository at this point in the history
This was arguably made too-visible previously and since all of the
consumable
symbols by the end users are re-exported via the //python:pip_bzl, we
can keep
everything that is in pip_install internal.

This could be a breaking change for people who are depending on internal
symbols or if they are using `whl_library` to create their own
implementation
of the `pip_repository` rule and are generating documentation
internally.
However, in that case they can apply a small patch to change the
visibility of
the `pip_repository_bzl` target.
  • Loading branch information
aignas authored and linzhp committed Oct 15, 2023
1 parent cc55561 commit 1737dfb
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 237 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ A brief description of the categories of changes:

## Unreleased

### Changed

* Make `//python/pip_install:pip_repository_bzl` `bzl_library` target internal
as all of the publicly available symbols (etc. `package_annotation`) are
re-exported via `//python:pip_bzl` `bzl_library`.

### Fixed

* Skip aliases for unloaded toolchains. Some Python versions that don't have full
Expand Down
11 changes: 0 additions & 11 deletions docs/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ licenses(["notice"]) # Apache 2.0
_DOCS = [
"packaging",
"pip",
"pip_repository",
"py_cc_toolchain",
"py_cc_toolchain_info",
# TODO @aignas 2023-10-09: move some of the example code from the `.bzl` files
Expand Down Expand Up @@ -94,16 +93,6 @@ stardoc(
],
)

stardoc(
name = "pip-repository",
out = "pip_repository.md.gen",
input = "//python/pip_install:pip_repository.bzl",
target_compatible_with = _TARGET_COMPATIBLE_WITH,
deps = [
"//python/pip_install:pip_repository_bzl",
],
)

stardoc(
name = "py-console-script-binary",
out = "py_console_script_binary.md.gen",
Expand Down
Loading

0 comments on commit 1737dfb

Please sign in to comment.